[deliverable/linux.git] / drivers / staging / omap-thermal / omap-thermal-common.c

/*
 * OMAP thermal driver interface
 *
 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
 * Contact:
 *   Eduardo Valentin <eduardo.valentin@ti.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#include <linux/device.h>
#include <linux/err.h>
#include <linux/mutex.h>
#include <linux/gfp.h>
#include <linux/kernel.h>
#include <linux/workqueue.h>
#include <linux/thermal.h>
#include <linux/cpufreq.h>
#include <linux/cpumask.h>
#include <linux/cpu_cooling.h>

#include "omap-thermal.h"
#include "omap-bandgap.h"

/* common data structures */
struct omap_thermal_data {
	struct thermal_zone_device *omap_thermal;
	struct thermal_cooling_device *cool_dev;
	struct omap_bandgap *bgp;
	enum thermal_device_mode mode;
	struct work_struct thermal_wq;
	int sensor_id;
};

static void omap_thermal_work(struct work_struct *work)
{
	struct omap_thermal_data *data = container_of(work,
					struct omap_thermal_data, thermal_wq);

	thermal_zone_device_update(data->omap_thermal);

	dev_dbg(&data->omap_thermal->device, "updated thermal zone %s\n",
		data->omap_thermal->type);
}

/**
 * omap_thermal_hotspot_temperature - returns sensor extrapolated temperature
 * @t:	omap sensor temperature
 * @s:	omap sensor slope value
 * @c:	omap sensor const value
 */
static inline int omap_thermal_hotspot_temperature(int t, int s, int c)
{
	int delta = t * s / 1000 + c;

	if (delta < 0)
		delta = 0;

	return t + delta;
}

/* thermal zone ops */
/* Get temperature callback function for thermal zone*/
static inline int omap_thermal_get_temp(struct thermal_zone_device *thermal,
					 unsigned long *temp)
{
	struct omap_thermal_data *data = thermal->devdata;
	struct omap_bandgap *bgp;
	struct omap_temp_sensor *s;
	int ret, tmp, pcb_temp, slope, constant;

	if (!data)
		return 0;

	bgp = data->bgp;
	s = &bgp->conf->sensors[data->sensor_id];

	ret = omap_bandgap_read_temperature(bgp, data->sensor_id, &tmp);
	if (ret)
		return ret;

	pcb_temp = 0;
	/* TODO: Introduce pcb temperature lookup */
	/* In case pcb zone is available, use the extrapolation rule with it */
	if (pcb_temp) {
		tmp -= pcb_temp;
		slope = s->slope_pcb;
		constant = s->constant_pcb;
	} else {
		slope = s->slope;
		constant = s->constant;
	}
	*temp = omap_thermal_hotspot_temperature(tmp, slope, constant);

	return ret;
}

/* Bind callback functions for thermal zone */
static int omap_thermal_bind(struct thermal_zone_device *thermal,
			      struct thermal_cooling_device *cdev)
{
	struct omap_thermal_data *data = thermal->devdata;
	int id;

	if (IS_ERR_OR_NULL(data))
		return -ENODEV;

	/* check if this is the cooling device we registered */
	if (data->cool_dev != cdev)
		return 0;

	id = data->sensor_id;

	/* TODO: bind with min and max states */
	/* Simple thing, two trips, one passive another critical */
	return thermal_zone_bind_cooling_device(thermal, 0, cdev,
						THERMAL_NO_LIMIT,
						THERMAL_NO_LIMIT);
}

/* Unbind callback functions for thermal zone */
static int omap_thermal_unbind(struct thermal_zone_device *thermal,
				struct thermal_cooling_device *cdev)
{
	struct omap_thermal_data *data = thermal->devdata;

	if (IS_ERR_OR_NULL(data))
		return -ENODEV;

	/* check if this is the cooling device we registered */
	if (data->cool_dev != cdev)
		return 0;

	/* Simple thing, two trips, one passive another critical */
	return thermal_zone_unbind_cooling_device(thermal, 0, cdev);
}

/* Get mode callback functions for thermal zone */
static int omap_thermal_get_mode(struct thermal_zone_device *thermal,
				  enum thermal_device_mode *mode)
{
	struct omap_thermal_data *data = thermal->devdata;

	if (data)
		*mode = data->mode;

	return 0;
}

/* Set mode callback functions for thermal zone */
static int omap_thermal_set_mode(struct thermal_zone_device *thermal,
				  enum thermal_device_mode mode)
{
	struct omap_thermal_data *data = thermal->devdata;

	if (!data->omap_thermal) {
		dev_notice(&thermal->device, "thermal zone not registered\n");
		return 0;
	}

	mutex_lock(&data->omap_thermal->lock);

	if (mode == THERMAL_DEVICE_ENABLED)
		data->omap_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
	else
		data->omap_thermal->polling_delay = 0;

	mutex_unlock(&data->omap_thermal->lock);

	data->mode = mode;
	thermal_zone_device_update(data->omap_thermal);
	dev_dbg(&thermal->device, "thermal polling set for duration=%d msec\n",
		data->omap_thermal->polling_delay);

	return 0;
}

/* Get trip type callback functions for thermal zone */
static int omap_thermal_get_trip_type(struct thermal_zone_device *thermal,
				       int trip, enum thermal_trip_type *type)
{
	if (!omap_thermal_is_valid_trip(trip))
		return -EINVAL;

	if (trip + 1 == OMAP_TRIP_NUMBER)
		*type = THERMAL_TRIP_CRITICAL;
	else
		*type = THERMAL_TRIP_PASSIVE;

	return 0;
}

/* Get trip temperature callback functions for thermal zone */
static int omap_thermal_get_trip_temp(struct thermal_zone_device *thermal,
				       int trip, unsigned long *temp)
{
	if (!omap_thermal_is_valid_trip(trip))
		return -EINVAL;

	*temp = omap_thermal_get_trip_value(trip);

	return 0;
}

/* Get critical temperature callback functions for thermal zone */
static int omap_thermal_get_crit_temp(struct thermal_zone_device *thermal,
				       unsigned long *temp)
{
	/* shutdown zone */
	return omap_thermal_get_trip_temp(thermal, OMAP_TRIP_NUMBER - 1, temp);
}

static struct thermal_zone_device_ops omap_thermal_ops = {
	.get_temp = omap_thermal_get_temp,
	/* TODO: add .get_trend */
	.bind = omap_thermal_bind,
	.unbind = omap_thermal_unbind,
	.get_mode = omap_thermal_get_mode,
	.set_mode = omap_thermal_set_mode,
	.get_trip_type = omap_thermal_get_trip_type,
	.get_trip_temp = omap_thermal_get_trip_temp,
	.get_crit_temp = omap_thermal_get_crit_temp,
};

static struct omap_thermal_data
*omap_thermal_build_data(struct omap_bandgap *bgp, int id)
{
	struct omap_thermal_data *data;

	data = devm_kzalloc(bgp->dev, sizeof(*data), GFP_KERNEL);
	if (!data) {
		dev_err(bgp->dev, "kzalloc fail\n");
		return NULL;
	}
	data->sensor_id = id;
	data->bgp = bgp;
	data->mode = THERMAL_DEVICE_ENABLED;
	INIT_WORK(&data->thermal_wq, omap_thermal_work);

	return data;
}

int omap_thermal_expose_sensor(struct omap_bandgap *bgp, int id,
			       char *domain)
{
	struct omap_thermal_data *data;

	data = omap_bandgap_get_sensor_data(bgp, id);

	if (IS_ERR_OR_NULL(data))
		data = omap_thermal_build_data(bgp, id);

	if (!data)
		return -EINVAL;

	/* TODO: remove TC1 TC2 */
	/* Create thermal zone */
	data->omap_thermal = thermal_zone_device_register(domain,
				OMAP_TRIP_NUMBER, 0, data, &omap_thermal_ops,
				NULL, FAST_TEMP_MONITORING_RATE,
				FAST_TEMP_MONITORING_RATE);
	if (IS_ERR_OR_NULL(data->omap_thermal)) {
		dev_err(bgp->dev, "thermal zone device is NULL\n");
		return PTR_ERR(data->omap_thermal);
	}
	data->omap_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
	omap_bandgap_set_sensor_data(bgp, id, data);

	return 0;
}

int omap_thermal_remove_sensor(struct omap_bandgap *bgp, int id)
{
	struct omap_thermal_data *data;

	data = omap_bandgap_get_sensor_data(bgp, id);

	thermal_zone_device_unregister(data->omap_thermal);

	return 0;
}

int omap_thermal_report_sensor_temperature(struct omap_bandgap *bgp, int id)
{
	struct omap_thermal_data *data;

	data = omap_bandgap_get_sensor_data(bgp, id);

	schedule_work(&data->thermal_wq);

	return 0;
}

int omap_thermal_register_cpu_cooling(struct omap_bandgap *bgp, int id)
{
	struct omap_thermal_data *data;

	data = omap_bandgap_get_sensor_data(bgp, id);
	if (IS_ERR_OR_NULL(data))
		data = omap_thermal_build_data(bgp, id);

	if (!data)
		return -EINVAL;

	/* Register cooling device */
	data->cool_dev = cpufreq_cooling_register(cpu_present_mask);
	if (IS_ERR_OR_NULL(data->cool_dev)) {
		dev_err(bgp->dev,
			"Failed to register cpufreq cooling device\n");
		return PTR_ERR(data->cool_dev);
	}
	omap_bandgap_set_sensor_data(bgp, id, data);

	return 0;
}

int omap_thermal_unregister_cpu_cooling(struct omap_bandgap *bgp, int id)
{
	struct omap_thermal_data *data;

	data = omap_bandgap_get_sensor_data(bgp, id);
	cpufreq_cooling_unregister(data->cool_dev);

	return 0;
}
Commit	Line	Data
445eaf87 EV	1	/*
	2	* OMAP thermal driver interface
	3	*
	4	* Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
	5	* Contact:
	6	* Eduardo Valentin <eduardo.valentin@ti.com>
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License
	10	* version 2 as published by the Free Software Foundation.
	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
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
	20	* 02110-1301 USA
	21	*
	22	*/
	23
	24	#include <linux/device.h>
	25	#include <linux/err.h>
	26	#include <linux/mutex.h>
	27	#include <linux/gfp.h>
	28	#include <linux/kernel.h>
	29	#include <linux/workqueue.h>
	30	#include <linux/thermal.h>
	31	#include <linux/cpufreq.h>
5035d48d	32	#include <linux/cpumask.h>
445eaf87 EV	33	#include <linux/cpu_cooling.h>
	34
	35	#include "omap-thermal.h"
	36	#include "omap-bandgap.h"
	37
	38	/* common data structures */
	39	struct omap_thermal_data {
	40	struct thermal_zone_device *omap_thermal;
	41	struct thermal_cooling_device *cool_dev;
d7f080e6	42	struct omap_bandgap *bgp;
445eaf87 EV	43	enum thermal_device_mode mode;
	44	struct work_struct thermal_wq;
	45	int sensor_id;
	46	};
	47
	48	static void omap_thermal_work(struct work_struct *work)
	49	{
	50	struct omap_thermal_data *data = container_of(work,
	51	struct omap_thermal_data, thermal_wq);
	52
	53	thermal_zone_device_update(data->omap_thermal);
	54
	55	dev_dbg(&data->omap_thermal->device, "updated thermal zone %s\n",
	56	data->omap_thermal->type);
	57	}
	58
	59	/**
	60	* omap_thermal_hotspot_temperature - returns sensor extrapolated temperature
	61	* @t: omap sensor temperature
	62	* @s: omap sensor slope value
	63	* @c: omap sensor const value
	64	*/
	65	static inline int omap_thermal_hotspot_temperature(int t, int s, int c)
	66	{
	67	int delta = t * s / 1000 + c;
	68
	69	if (delta < 0)
	70	delta = 0;
	71
	72	return t + delta;
	73	}
	74
	75	/* thermal zone ops */
	76	/* Get temperature callback function for thermal zone*/
	77	static inline int omap_thermal_get_temp(struct thermal_zone_device *thermal,
	78	unsigned long *temp)
	79	{
	80	struct omap_thermal_data *data = thermal->devdata;
d7f080e6	81	struct omap_bandgap *bgp;
04a4d10d	82	struct omap_temp_sensor *s;
445eaf87 EV	83	int ret, tmp, pcb_temp, slope, constant;
445eaf87 EV	84
04a4d10d EV	85	if (!data)
	86	return 0;
	87
d7f080e6 EV	88	bgp = data->bgp;
d7f080e6 EV	89	s = &bgp->conf->sensors[data->sensor_id];
04a4d10d	90
d7f080e6	91	ret = omap_bandgap_read_temperature(bgp, data->sensor_id, &tmp);
445eaf87 EV	92	if (ret)
	93	return ret;
	94
	95	pcb_temp = 0;
	96	/* TODO: Introduce pcb temperature lookup */
	97	/* In case pcb zone is available, use the extrapolation rule with it */
	98	if (pcb_temp) {
	99	tmp -= pcb_temp;
	100	slope = s->slope_pcb;
	101	constant = s->constant_pcb;
	102	} else {
	103	slope = s->slope;
	104	constant = s->constant;
	105	}
	106	*temp = omap_thermal_hotspot_temperature(tmp, slope, constant);
	107
	108	return ret;
	109	}
	110
	111	/* Bind callback functions for thermal zone */
	112	static int omap_thermal_bind(struct thermal_zone_device *thermal,
	113	struct thermal_cooling_device *cdev)
	114	{
	115	struct omap_thermal_data *data = thermal->devdata;
5035d48d	116	int id;
445eaf87 EV	117
	118	if (IS_ERR_OR_NULL(data))
	119	return -ENODEV;
	120
	121	/* check if this is the cooling device we registered */
	122	if (data->cool_dev != cdev)
	123	return 0;
	124
	125	id = data->sensor_id;
445eaf87 EV	126
	127	/* TODO: bind with min and max states */
	128	/* Simple thing, two trips, one passive another critical */
a7a3b8c8 EV	129	return thermal_zone_bind_cooling_device(thermal, 0, cdev,
	130	THERMAL_NO_LIMIT,
	131	THERMAL_NO_LIMIT);
445eaf87 EV	132	}
	133
	134	/* Unbind callback functions for thermal zone */
	135	static int omap_thermal_unbind(struct thermal_zone_device *thermal,
	136	struct thermal_cooling_device *cdev)
	137	{
	138	struct omap_thermal_data *data = thermal->devdata;
	139
	140	if (IS_ERR_OR_NULL(data))
	141	return -ENODEV;
	142
	143	/* check if this is the cooling device we registered */
	144	if (data->cool_dev != cdev)
	145	return 0;
	146
	147	/* Simple thing, two trips, one passive another critical */
	148	return thermal_zone_unbind_cooling_device(thermal, 0, cdev);
	149	}
	150
	151	/* Get mode callback functions for thermal zone */
	152	static int omap_thermal_get_mode(struct thermal_zone_device *thermal,
	153	enum thermal_device_mode *mode)
	154	{
	155	struct omap_thermal_data *data = thermal->devdata;
	156
	157	if (data)
	158	*mode = data->mode;
	159
	160	return 0;
	161	}
	162
	163	/* Set mode callback functions for thermal zone */
	164	static int omap_thermal_set_mode(struct thermal_zone_device *thermal,
	165	enum thermal_device_mode mode)
	166	{
	167	struct omap_thermal_data *data = thermal->devdata;
	168
	169	if (!data->omap_thermal) {
	170	dev_notice(&thermal->device, "thermal zone not registered\n");
	171	return 0;
	172	}
	173
	174	mutex_lock(&data->omap_thermal->lock);
	175
	176	if (mode == THERMAL_DEVICE_ENABLED)
	177	data->omap_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
	178	else
	179	data->omap_thermal->polling_delay = 0;
	180
	181	mutex_unlock(&data->omap_thermal->lock);
	182
	183	data->mode = mode;
	184	thermal_zone_device_update(data->omap_thermal);
	185	dev_dbg(&thermal->device, "thermal polling set for duration=%d msec\n",
	186	data->omap_thermal->polling_delay);
	187
	188	return 0;
	189	}
	190
	191	/* Get trip type callback functions for thermal zone */
	192	static int omap_thermal_get_trip_type(struct thermal_zone_device *thermal,
	193	int trip, enum thermal_trip_type *type)
	194	{
	195	if (!omap_thermal_is_valid_trip(trip))
196	return -EINVAL;
197
198	if (trip + 1 == OMAP_TRIP_NUMBER)
199	*type = THERMAL_TRIP_CRITICAL;
200	else
201	*type = THERMAL_TRIP_PASSIVE;
202
203	return 0;
204	}
205
206	/* Get trip temperature callback functions for thermal zone */
207	static int omap_thermal_get_trip_temp(struct thermal_zone_device *thermal,
208	int trip, unsigned long *temp)
209	{
210	if (!omap_thermal_is_valid_trip(trip))
211	return -EINVAL;
212
213	*temp = omap_thermal_get_trip_value(trip);
214
215	return 0;
216	}
217
218	/* Get critical temperature callback functions for thermal zone */
219	static int omap_thermal_get_crit_temp(struct thermal_zone_device *thermal,
220	unsigned long *temp)
221	{
222	/* shutdown zone */
223	return omap_thermal_get_trip_temp(thermal, OMAP_TRIP_NUMBER - 1, temp);
224	}
225
226	static struct thermal_zone_device_ops omap_thermal_ops = {
227	.get_temp = omap_thermal_get_temp,
228	/* TODO: add .get_trend */
229	.bind = omap_thermal_bind,
230	.unbind = omap_thermal_unbind,
231	.get_mode = omap_thermal_get_mode,
232	.set_mode = omap_thermal_set_mode,
233	.get_trip_type = omap_thermal_get_trip_type,
234	.get_trip_temp = omap_thermal_get_trip_temp,
235	.get_crit_temp = omap_thermal_get_crit_temp,
236	};
237
04a4d10d	238	static struct omap_thermal_data
d7f080e6	239	omap_thermal_build_data(struct omap_bandgap bgp, int id)
445eaf87 EV	240	{
	241	struct omap_thermal_data *data;
	242
d7f080e6	243	data = devm_kzalloc(bgp->dev, sizeof(*data), GFP_KERNEL);
445eaf87	244	if (!data) {
d7f080e6	245	dev_err(bgp->dev, "kzalloc fail\n");
04a4d10d	246	return NULL;
445eaf87 EV	247	}
445eaf87 EV	248	data->sensor_id = id;
d7f080e6	249	data->bgp = bgp;
445eaf87 EV	250	data->mode = THERMAL_DEVICE_ENABLED;
	251	INIT_WORK(&data->thermal_wq, omap_thermal_work);
	252
04a4d10d EV	253	return data;
	254	}
	255
d7f080e6	256	int omap_thermal_expose_sensor(struct omap_bandgap *bgp, int id,
04a4d10d EV	257	char *domain)
04a4d10d EV	258	{
50419491	259	struct omap_thermal_data *data;
04a4d10d	260
d7f080e6	261	data = omap_bandgap_get_sensor_data(bgp, id);
04a4d10d	262
35b052a6	263	if (IS_ERR_OR_NULL(data))
d7f080e6	264	data = omap_thermal_build_data(bgp, id);
04a4d10d EV	265
	266	if (!data)
	267	return -EINVAL;
	268
445eaf87 EV	269	/* TODO: remove TC1 TC2 */
	270	/* Create thermal zone */
	271	data->omap_thermal = thermal_zone_device_register(domain,
	272	OMAP_TRIP_NUMBER, 0, data, &omap_thermal_ops,
50125a9b	273	NULL, FAST_TEMP_MONITORING_RATE,
765a1939	274	FAST_TEMP_MONITORING_RATE);
445eaf87	275	if (IS_ERR_OR_NULL(data->omap_thermal)) {
d7f080e6	276	dev_err(bgp->dev, "thermal zone device is NULL\n");
445eaf87 EV	277	return PTR_ERR(data->omap_thermal);
	278	}
	279	data->omap_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
d7f080e6	280	omap_bandgap_set_sensor_data(bgp, id, data);
445eaf87 EV	281
	282	return 0;
	283	}
	284
d7f080e6	285	int omap_thermal_remove_sensor(struct omap_bandgap *bgp, int id)
445eaf87 EV	286	{
	287	struct omap_thermal_data *data;
	288
d7f080e6	289	data = omap_bandgap_get_sensor_data(bgp, id);
445eaf87 EV	290
	291	thermal_zone_device_unregister(data->omap_thermal);
	292
	293	return 0;
	294	}
	295
d7f080e6	296	int omap_thermal_report_sensor_temperature(struct omap_bandgap *bgp, int id)
445eaf87 EV	297	{
	298	struct omap_thermal_data *data;
	299
d7f080e6	300	data = omap_bandgap_get_sensor_data(bgp, id);
445eaf87 EV	301
	302	schedule_work(&data->thermal_wq);
	303
	304	return 0;
	305	}
	306
d7f080e6	307	int omap_thermal_register_cpu_cooling(struct omap_bandgap *bgp, int id)
445eaf87 EV	308	{
445eaf87 EV	309	struct omap_thermal_data *data;
445eaf87	310
d7f080e6	311	data = omap_bandgap_get_sensor_data(bgp, id);
35b052a6	312	if (IS_ERR_OR_NULL(data))
d7f080e6	313	data = omap_thermal_build_data(bgp, id);
04a4d10d EV	314
	315	if (!data)
	316	return -EINVAL;
445eaf87	317
445eaf87	318	/* Register cooling device */
5035d48d	319	data->cool_dev = cpufreq_cooling_register(cpu_present_mask);
445eaf87	320	if (IS_ERR_OR_NULL(data->cool_dev)) {
d7f080e6	321	dev_err(bgp->dev,
445eaf87 EV	322	"Failed to register cpufreq cooling device\n");
	323	return PTR_ERR(data->cool_dev);
	324	}
d7f080e6	325	omap_bandgap_set_sensor_data(bgp, id, data);
445eaf87 EV	326
	327	return 0;
	328	}
	329
d7f080e6	330	int omap_thermal_unregister_cpu_cooling(struct omap_bandgap *bgp, int id)
445eaf87 EV	331	{
	332	struct omap_thermal_data *data;
	333
d7f080e6	334	data = omap_bandgap_get_sensor_data(bgp, id);
445eaf87 EV	335	cpufreq_cooling_unregister(data->cool_dev);
	336
	337	return 0;
	338	}