[net-next-2.6.git] / drivers / macintosh / therm_adt746x.c

/*
 * Device driver for the i2c thermostat found on the iBook G4, Albook G4
 *
 * Copyright (C) 2003, 2004 Colin Leroy, Rasmus Rohde, Benjamin Herrenschmidt
 *
 * Documentation from
 * http://www.analog.com/UploadedFiles/Data_Sheets/115254175ADT7467_pra.pdf
 * http://www.analog.com/UploadedFiles/Data_Sheets/3686221171167ADT7460_b.pdf
 *
 */

#include <linux/types.h>
#include <linux/module.h>
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/sched.h>
#include <linux/i2c.h>
#include <linux/slab.h>
#include <linux/init.h>
#include <linux/spinlock.h>
#include <linux/smp_lock.h>
#include <linux/wait.h>
#include <linux/suspend.h>
#include <linux/kthread.h>
#include <linux/moduleparam.h>
#include <linux/freezer.h>

#include <asm/prom.h>
#include <asm/machdep.h>
#include <asm/io.h>
#include <asm/system.h>
#include <asm/sections.h>
#include <asm/of_platform.h>

#undef DEBUG

#define CONFIG_REG   0x40
#define MANUAL_MASK  0xe0
#define AUTO_MASK    0x20

static u8 TEMP_REG[3]    = {0x26, 0x25, 0x27}; /* local, sensor1, sensor2 */
static u8 LIMIT_REG[3]   = {0x6b, 0x6a, 0x6c}; /* local, sensor1, sensor2 */
static u8 MANUAL_MODE[2] = {0x5c, 0x5d};       
static u8 REM_CONTROL[2] = {0x00, 0x40};
static u8 FAN_SPEED[2]   = {0x28, 0x2a};
static u8 FAN_SPD_SET[2] = {0x30, 0x31};

static u8 default_limits_local[3] = {70, 50, 70};    /* local, sensor1, sensor2 */
static u8 default_limits_chip[3] = {80, 65, 80};    /* local, sensor1, sensor2 */
static const char *sensor_location[3] = {NULL, NULL, NULL};

static int limit_adjust = 0;
static int fan_speed = -1;
static int verbose = 0;

MODULE_AUTHOR("Colin Leroy <colin@colino.net>");
MODULE_DESCRIPTION("Driver for ADT746x thermostat in iBook G4 and "
		   "Powerbook G4 Alu");
MODULE_LICENSE("GPL");

module_param(limit_adjust, int, 0644);
MODULE_PARM_DESC(limit_adjust,"Adjust maximum temperatures (50 sensor1, 70 sensor2) "
		 "by N degrees.");

module_param(fan_speed, int, 0644);
MODULE_PARM_DESC(fan_speed,"Specify starting fan speed (0-255) "
		 "(default 64)");

module_param(verbose, bool, 0);
MODULE_PARM_DESC(verbose,"Verbose log operations "
		 "(default 0)");

struct thermostat {
	struct i2c_client	clt;
	u8			temps[3];
	u8			cached_temp[3];
	u8			initial_limits[3];
	u8			limits[3];
	int			last_speed[2];
	int			last_var[2];
};

static enum {ADT7460, ADT7467} therm_type;
static int therm_bus, therm_address;
static struct of_device * of_dev;
static struct thermostat* thermostat;
static struct task_struct *thread_therm = NULL;

static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
				 int busno);

static void write_both_fan_speed(struct thermostat *th, int speed);
static void write_fan_speed(struct thermostat *th, int speed, int fan);

static int
write_reg(struct thermostat* th, int reg, u8 data)
{
	u8 tmp[2];
	int rc;
	
	tmp[0] = reg;
	tmp[1] = data;
	rc = i2c_master_send(&th->clt, (const char *)tmp, 2);
	if (rc < 0)
		return rc;
	if (rc != 2)
		return -ENODEV;
	return 0;
}

static int
read_reg(struct thermostat* th, int reg)
{
	u8 reg_addr, data;
	int rc;

	reg_addr = (u8)reg;
	rc = i2c_master_send(&th->clt, &reg_addr, 1);
	if (rc < 0)
		return rc;
	if (rc != 1)
		return -ENODEV;
	rc = i2c_master_recv(&th->clt, (char *)&data, 1);
	if (rc < 0)
		return rc;
	return data;
}

static int
attach_thermostat(struct i2c_adapter *adapter)
{
	unsigned long bus_no;

	if (strncmp(adapter->name, "uni-n", 5))
		return -ENODEV;
	bus_no = simple_strtoul(adapter->name + 6, NULL, 10);
	if (bus_no != therm_bus)
		return -ENODEV;
	return attach_one_thermostat(adapter, therm_address, bus_no);
}

static int
detach_thermostat(struct i2c_adapter *adapter)
{
	struct thermostat* th;
	int i;
	
	if (thermostat == NULL)
		return 0;

	th = thermostat;

	if (thread_therm != NULL) {
		kthread_stop(thread_therm);
	}

	printk(KERN_INFO "adt746x: Putting max temperatures back from "
			 "%d, %d, %d to %d, %d, %d\n",
		th->limits[0], th->limits[1], th->limits[2],
		th->initial_limits[0], th->initial_limits[1],
		th->initial_limits[2]);

	for (i = 0; i < 3; i++)
		write_reg(th, LIMIT_REG[i], th->initial_limits[i]);

	write_both_fan_speed(th, -1);

	i2c_detach_client(&th->clt);

	thermostat = NULL;

	kfree(th);

	return 0;
}

static struct i2c_driver thermostat_driver = {  
	.driver = {
		.name	= "therm_adt746x",
	},
	.attach_adapter	= attach_thermostat,
	.detach_adapter	= detach_thermostat,
};

static int read_fan_speed(struct thermostat *th, u8 addr)
{
	u8 tmp[2];
	u16 res;
	
	/* should start with low byte */
	tmp[1] = read_reg(th, addr);
	tmp[0] = read_reg(th, addr + 1);
	
	res = tmp[1] + (tmp[0] << 8);
	/* "a value of 0xffff means that the fan has stopped" */
	return (res == 0xffff ? 0 : (90000*60)/res);
}

static void write_both_fan_speed(struct thermostat *th, int speed)
{
	write_fan_speed(th, speed, 0);
	if (therm_type == ADT7460)
		write_fan_speed(th, speed, 1);
}

static void write_fan_speed(struct thermostat *th, int speed, int fan)
{
	u8 manual;
	
	if (speed > 0xff) 
		speed = 0xff;
	else if (speed < -1) 
		speed = 0;
	
	if (therm_type == ADT7467 && fan == 1)
		return;
	
	if (th->last_speed[fan] != speed) {
		if (verbose) {
			if (speed == -1)
				printk(KERN_DEBUG "adt746x: Setting speed to automatic "
					"for %s fan.\n", sensor_location[fan+1]);
			else
				printk(KERN_DEBUG "adt746x: Setting speed to %d "
					"for %s fan.\n", speed, sensor_location[fan+1]);
		}
	} else
		return;
	
	if (speed >= 0) {
		manual = read_reg(th, MANUAL_MODE[fan]);
		write_reg(th, MANUAL_MODE[fan], manual|MANUAL_MASK);
		write_reg(th, FAN_SPD_SET[fan], speed);
	} else {
		/* back to automatic */
		if(therm_type == ADT7460) {
			manual = read_reg(th,
				MANUAL_MODE[fan]) & (~MANUAL_MASK);

			write_reg(th,
				MANUAL_MODE[fan], manual|REM_CONTROL[fan]);
		} else {
			manual = read_reg(th, MANUAL_MODE[fan]);
			write_reg(th, MANUAL_MODE[fan], manual&(~AUTO_MASK));
		}
	}
	
	th->last_speed[fan] = speed;			
}

static void read_sensors(struct thermostat *th)
{
	int i = 0;

	for (i = 0; i < 3; i++)
		th->temps[i]  = read_reg(th, TEMP_REG[i]);
}

#ifdef DEBUG
static void display_stats(struct thermostat *th)
{
	if (th->temps[0] != th->cached_temp[0]
	||  th->temps[1] != th->cached_temp[1]
	||  th->temps[2] != th->cached_temp[2]) {
		printk(KERN_INFO "adt746x: Temperature infos:"
				 " thermostats: %d,%d,%d;"
				 " limits: %d,%d,%d;"
				 " fan speed: %d RPM\n",
				 th->temps[0], th->temps[1], th->temps[2],
				 th->limits[0],  th->limits[1],  th->limits[2],
				 read_fan_speed(th, FAN_SPEED[0]));
	}
	th->cached_temp[0] = th->temps[0];
	th->cached_temp[1] = th->temps[1];
	th->cached_temp[2] = th->temps[2];
}
#endif

static void update_fans_speed (struct thermostat *th)
{
	int lastvar = 0; /* last variation, for iBook */
	int i = 0;

	/* we don't care about local sensor, so we start at sensor 1 */
	for (i = 1; i < 3; i++) {
		int started = 0;
		int fan_number = (therm_type == ADT7460 && i == 2);
		int var = th->temps[i] - th->limits[i];

		if (var > -1) {
			int step = (255 - fan_speed) / 7;
			int new_speed = 0;

			/* hysteresis : change fan speed only if variation is
			 * more than two degrees */
			if (abs(var - th->last_var[fan_number]) < 2)
				continue;

			started = 1;
			new_speed = fan_speed + ((var-1)*step);

			if (new_speed < fan_speed)
				new_speed = fan_speed;
			if (new_speed > 255)
				new_speed = 255;

			if (verbose)
				printk(KERN_DEBUG "adt746x: Setting fans speed to %d "
						 "(limit exceeded by %d on %s) \n",
						new_speed, var,
						sensor_location[fan_number+1]);
			write_both_fan_speed(th, new_speed);
			th->last_var[fan_number] = var;
		} else if (var < -2) {
			/* don't stop fan if sensor2 is cold and sensor1 is not
			 * so cold (lastvar >= -1) */
			if (i == 2 && lastvar < -1) {
				if (th->last_speed[fan_number] != 0)
					if (verbose)
						printk(KERN_DEBUG "adt746x: Stopping "
							"fans.\n");
				write_both_fan_speed(th, 0);
			}
		}

		lastvar = var;

		if (started)
			return; /* we don't want to re-stop the fan
				* if sensor1 is heating and sensor2 is not */
	}
}

static int monitor_task(void *arg)
{
	struct thermostat* th = arg;

	while(!kthread_should_stop()) {
		try_to_freeze();
		msleep_interruptible(2000);

#ifndef DEBUG
		if (fan_speed != -1)
			read_sensors(th);
#else
		read_sensors(th);
#endif		

		if (fan_speed != -1)
			update_fans_speed(th);

#ifdef DEBUG
		display_stats(th);
#endif

	}

	return 0;
}

static void set_limit(struct thermostat *th, int i)
{
		/* Set sensor1 limit higher to avoid powerdowns */
		th->limits[i] = default_limits_chip[i] + limit_adjust;
		write_reg(th, LIMIT_REG[i], th->limits[i]);
		
		/* set our limits to normal */
		th->limits[i] = default_limits_local[i] + limit_adjust;
}

static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
				 int busno)
{
	struct thermostat* th;
	int rc;
	int i;

	if (thermostat)
		return 0;

	th = (struct thermostat *)
		kmalloc(sizeof(struct thermostat), GFP_KERNEL);

	if (!th)
		return -ENOMEM;

	memset(th, 0, sizeof(*th));
	th->clt.addr = addr;
	th->clt.adapter = adapter;
	th->clt.driver = &thermostat_driver;
	strcpy(th->clt.name, "thermostat");

	rc = read_reg(th, 0);
	if (rc < 0) {
		printk(KERN_ERR "adt746x: Thermostat failed to read config "
				"from bus %d !\n",
				busno);
		kfree(th);
		return -ENODEV;
	}

	/* force manual control to start the fan quieter */
	if (fan_speed == -1)
		fan_speed = 64;
	
	if(therm_type == ADT7460) {
		printk(KERN_INFO "adt746x: ADT7460 initializing\n");
		/* The 7460 needs to be started explicitly */
		write_reg(th, CONFIG_REG, 1);
	} else
		printk(KERN_INFO "adt746x: ADT7467 initializing\n");

	for (i = 0; i < 3; i++) {
		th->initial_limits[i] = read_reg(th, LIMIT_REG[i]);
		set_limit(th, i);
	}

	printk(KERN_INFO "adt746x: Lowering max temperatures from %d, %d, %d"
			 " to %d, %d, %d\n",
			 th->initial_limits[0], th->initial_limits[1],
			 th->initial_limits[2], th->limits[0], th->limits[1],
			 th->limits[2]);

	thermostat = th;

	if (i2c_attach_client(&th->clt)) {
		printk(KERN_INFO "adt746x: Thermostat failed to attach "
				 "client !\n");
		thermostat = NULL;
		kfree(th);
		return -ENODEV;
	}

	/* be sure to really write fan speed the first time */
	th->last_speed[0] = -2;
	th->last_speed[1] = -2;
	th->last_var[0] = -80;
	th->last_var[1] = -80;

	if (fan_speed != -1) {
		/* manual mode, stop fans */
		write_both_fan_speed(th, 0);
	} else {
		/* automatic mode */
		write_both_fan_speed(th, -1);
	}
	
	thread_therm = kthread_run(monitor_task, th, "kfand");

	if (thread_therm == ERR_PTR(-ENOMEM)) {
		printk(KERN_INFO "adt746x: Kthread creation failed\n");
		thread_therm = NULL;
		return -ENOMEM;
	}

	return 0;
}

/* 
 * Now, unfortunately, sysfs doesn't give us a nice void * we could
 * pass around to the attribute functions, so we don't really have
 * choice but implement a bunch of them...
 *
 * FIXME, it does now...
 */
#define BUILD_SHOW_FUNC_INT(name, data)				\
static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)	\
{								\
	return sprintf(buf, "%d\n", data);			\
}

#define BUILD_SHOW_FUNC_STR(name, data)				\
static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)       \
{								\
	return sprintf(buf, "%s\n", data);			\
}

#define BUILD_SHOW_FUNC_FAN(name, data)				\
static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)       \
{								\
	return sprintf(buf, "%d (%d rpm)\n", 			\
		thermostat->last_speed[data],			\
		read_fan_speed(thermostat, FAN_SPEED[data])	\
		);						\
}

#define BUILD_STORE_FUNC_DEG(name, data)			\
static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
{								\
	int val;						\
	int i;							\
	val = simple_strtol(buf, NULL, 10);			\
	printk(KERN_INFO "Adjusting limits by %d degrees\n", val);	\
	limit_adjust = val;					\
	for (i=0; i < 3; i++)					\
		set_limit(thermostat, i);			\
	return n;						\
}

#define BUILD_STORE_FUNC_INT(name, data)			\
static ssize_t store_##name(struct device *dev, struct device_attribute *attr, const char *buf, size_t n) \
{								\
	u32 val;						\
	val = simple_strtoul(buf, NULL, 10);			\
	if (val < 0 || val > 255)				\
		return -EINVAL;					\
	printk(KERN_INFO "Setting specified fan speed to %d\n", val);	\
	data = val;						\
	return n;						\
}

BUILD_SHOW_FUNC_INT(sensor1_temperature,	 (read_reg(thermostat, TEMP_REG[1])))
BUILD_SHOW_FUNC_INT(sensor2_temperature,	 (read_reg(thermostat, TEMP_REG[2])))
BUILD_SHOW_FUNC_INT(sensor1_limit,		 thermostat->limits[1])
BUILD_SHOW_FUNC_INT(sensor2_limit,		 thermostat->limits[2])
BUILD_SHOW_FUNC_STR(sensor1_location,		 sensor_location[1])
BUILD_SHOW_FUNC_STR(sensor2_location,		 sensor_location[2])

BUILD_SHOW_FUNC_INT(specified_fan_speed, fan_speed)
BUILD_SHOW_FUNC_FAN(sensor1_fan_speed,	 0)
BUILD_SHOW_FUNC_FAN(sensor2_fan_speed,	 1)

BUILD_STORE_FUNC_INT(specified_fan_speed,fan_speed)
BUILD_SHOW_FUNC_INT(limit_adjust,	 limit_adjust)
BUILD_STORE_FUNC_DEG(limit_adjust,	 thermostat)
		
static DEVICE_ATTR(sensor1_temperature,	S_IRUGO,
		   show_sensor1_temperature,NULL);
static DEVICE_ATTR(sensor2_temperature,	S_IRUGO,
		   show_sensor2_temperature,NULL);
static DEVICE_ATTR(sensor1_limit, S_IRUGO,
		   show_sensor1_limit,	NULL);
static DEVICE_ATTR(sensor2_limit, S_IRUGO,
		   show_sensor2_limit,	NULL);
static DEVICE_ATTR(sensor1_location, S_IRUGO,
		   show_sensor1_location, NULL);
static DEVICE_ATTR(sensor2_location, S_IRUGO,
		   show_sensor2_location, NULL);

static DEVICE_ATTR(specified_fan_speed,	S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
		   show_specified_fan_speed,store_specified_fan_speed);

static DEVICE_ATTR(sensor1_fan_speed,	S_IRUGO,
		   show_sensor1_fan_speed,	NULL);
static DEVICE_ATTR(sensor2_fan_speed,	S_IRUGO,
		   show_sensor2_fan_speed,	NULL);

static DEVICE_ATTR(limit_adjust,	S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH,
		   show_limit_adjust,	store_limit_adjust);


static int __init
thermostat_init(void)
{
	struct device_node* np;
	const u32 *prop;
	int i = 0, offset = 0;
	
	np = of_find_node_by_name(NULL, "fan");
	if (!np)
		return -ENODEV;
	if (device_is_compatible(np, "adt7460"))
		therm_type = ADT7460;
	else if (device_is_compatible(np, "adt7467"))
		therm_type = ADT7467;
	else
		return -ENODEV;

	prop = get_property(np, "hwsensor-params-version", NULL);
	printk(KERN_INFO "adt746x: version %d (%ssupported)\n", *prop,
			 (*prop == 1)?"":"un");
	if (*prop != 1)
		return -ENODEV;

	prop = get_property(np, "reg", NULL);
	if (!prop)
		return -ENODEV;

	/* look for bus either by path or using "reg" */
	if (strstr(np->full_name, "/i2c-bus@") != NULL) {
		const char *tmp_bus = (strstr(np->full_name, "/i2c-bus@") + 9);
		therm_bus = tmp_bus[0]-'0';
	} else {
		therm_bus = ((*prop) >> 8) & 0x0f;
	}

	therm_address = ((*prop) & 0xff) >> 1;

	printk(KERN_INFO "adt746x: Thermostat bus: %d, address: 0x%02x, "
			 "limit_adjust: %d, fan_speed: %d\n",
			 therm_bus, therm_address, limit_adjust, fan_speed);

	if (get_property(np, "hwsensor-location", NULL)) {
		for (i = 0; i < 3; i++) {
			sensor_location[i] = get_property(np,
					"hwsensor-location", NULL) + offset;

			if (sensor_location[i] == NULL)
				sensor_location[i] = "";

			printk(KERN_INFO "sensor %d: %s\n", i, sensor_location[i]);
			offset += strlen(sensor_location[i]) + 1;
		}
	} else {
		sensor_location[0] = "?";
		sensor_location[1] = "?";
		sensor_location[2] = "?";
	}

	of_dev = of_platform_device_create(np, "temperatures", NULL);
	
	if (of_dev == NULL) {
		printk(KERN_ERR "Can't register temperatures device !\n");
		return -ENODEV;
	}
	
	device_create_file(&of_dev->dev, &dev_attr_sensor1_temperature);
	device_create_file(&of_dev->dev, &dev_attr_sensor2_temperature);
	device_create_file(&of_dev->dev, &dev_attr_sensor1_limit);
	device_create_file(&of_dev->dev, &dev_attr_sensor2_limit);
	device_create_file(&of_dev->dev, &dev_attr_sensor1_location);
	device_create_file(&of_dev->dev, &dev_attr_sensor2_location);
	device_create_file(&of_dev->dev, &dev_attr_limit_adjust);
	device_create_file(&of_dev->dev, &dev_attr_specified_fan_speed);
	device_create_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
	if(therm_type == ADT7460)
		device_create_file(&of_dev->dev, &dev_attr_sensor2_fan_speed);

#ifndef CONFIG_I2C_POWERMAC
	request_module("i2c-powermac");
#endif

	return i2c_add_driver(&thermostat_driver);
}

static void __exit
thermostat_exit(void)
{
	if (of_dev) {
		device_remove_file(&of_dev->dev, &dev_attr_sensor1_temperature);
		device_remove_file(&of_dev->dev, &dev_attr_sensor2_temperature);
		device_remove_file(&of_dev->dev, &dev_attr_sensor1_limit);
		device_remove_file(&of_dev->dev, &dev_attr_sensor2_limit);
		device_remove_file(&of_dev->dev, &dev_attr_sensor1_location);
		device_remove_file(&of_dev->dev, &dev_attr_sensor2_location);
		device_remove_file(&of_dev->dev, &dev_attr_limit_adjust);
		device_remove_file(&of_dev->dev, &dev_attr_specified_fan_speed);
		device_remove_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);

		if(therm_type == ADT7460)
			device_remove_file(&of_dev->dev,
					   &dev_attr_sensor2_fan_speed);

		of_device_unregister(of_dev);
	}
	i2c_del_driver(&thermostat_driver);
}

module_init(thermostat_init);
module_exit(thermostat_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Device driver for the i2c thermostat found on the iBook G4, Albook G4
	3	*
	4	* Copyright (C) 2003, 2004 Colin Leroy, Rasmus Rohde, Benjamin Herrenschmidt
	5	*
	6	* Documentation from
	7	* http://www.analog.com/UploadedFiles/Data_Sheets/115254175ADT7467_pra.pdf
	8	* http://www.analog.com/UploadedFiles/Data_Sheets/3686221171167ADT7460_b.pdf
	9	*
	10	*/
	11
1da177e4 LT	12	#include <linux/types.h>
	13	#include <linux/module.h>
	14	#include <linux/errno.h>
	15	#include <linux/kernel.h>
	16	#include <linux/delay.h>
	17	#include <linux/sched.h>
	18	#include <linux/i2c.h>
	19	#include <linux/slab.h>
	20	#include <linux/init.h>
	21	#include <linux/spinlock.h>
	22	#include <linux/smp_lock.h>
	23	#include <linux/wait.h>
	24	#include <linux/suspend.h>
	25	#include <linux/kthread.h>
	26	#include <linux/moduleparam.h>
7dfb7103	27	#include <linux/freezer.h>
1da177e4 LT	28
	29	#include <asm/prom.h>
	30	#include <asm/machdep.h>
	31	#include <asm/io.h>
	32	#include <asm/system.h>
	33	#include <asm/sections.h>
7eebde70	34	#include <asm/of_platform.h>
1da177e4 LT	35
	36	#undef DEBUG
	37
	38	#define CONFIG_REG 0x40
	39	#define MANUAL_MASK 0xe0
	40	#define AUTO_MASK 0x20
	41
d20c507f CL	42	static u8 TEMP_REG[3] = {0x26, 0x25, 0x27}; /* local, sensor1, sensor2 */
d20c507f CL	43	static u8 LIMIT_REG[3] = {0x6b, 0x6a, 0x6c}; /* local, sensor1, sensor2 */
1da177e4 LT	44	static u8 MANUAL_MODE[2] = {0x5c, 0x5d};
	45	static u8 REM_CONTROL[2] = {0x00, 0x40};
	46	static u8 FAN_SPEED[2] = {0x28, 0x2a};
	47	static u8 FAN_SPD_SET[2] = {0x30, 0x31};
	48
d20c507f CL	49	static u8 default_limits_local[3] = {70, 50, 70}; /* local, sensor1, sensor2 */
d20c507f CL	50	static u8 default_limits_chip[3] = {80, 65, 80}; /* local, sensor1, sensor2 */
018a3d1d	51	static const char *sensor_location[3] = {NULL, NULL, NULL};
1da177e4 LT	52
	53	static int limit_adjust = 0;
	54	static int fan_speed = -1;
9f6d4b0c	55	static int verbose = 0;
1da177e4 LT	56
	57	MODULE_AUTHOR("Colin Leroy <colin@colino.net>");
	58	MODULE_DESCRIPTION("Driver for ADT746x thermostat in iBook G4 and "
	59	"Powerbook G4 Alu");
	60	MODULE_LICENSE("GPL");
	61
	62	module_param(limit_adjust, int, 0644);
d20c507f	63	MODULE_PARM_DESC(limit_adjust,"Adjust maximum temperatures (50 sensor1, 70 sensor2) "
1da177e4 LT	64	"by N degrees.");
	65
	66	module_param(fan_speed, int, 0644);
	67	MODULE_PARM_DESC(fan_speed,"Specify starting fan speed (0-255) "
	68	"(default 64)");
	69
9f6d4b0c BC	70	module_param(verbose, bool, 0);
	71	MODULE_PARM_DESC(verbose,"Verbose log operations "
	72	"(default 0)");
	73
1da177e4 LT	74	struct thermostat {
	75	struct i2c_client clt;
	76	u8 temps[3];
	77	u8 cached_temp[3];
	78	u8 initial_limits[3];
	79	u8 limits[3];
	80	int last_speed[2];
	81	int last_var[2];
	82	};
	83
	84	static enum {ADT7460, ADT7467} therm_type;
	85	static int therm_bus, therm_address;
	86	static struct of_device * of_dev;
	87	static struct thermostat* thermostat;
	88	static struct task_struct *thread_therm = NULL;
	89
	90	static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
	91	int busno);
	92
	93	static void write_both_fan_speed(struct thermostat *th, int speed);
	94	static void write_fan_speed(struct thermostat *th, int speed, int fan);
	95
	96	static int
	97	write_reg(struct thermostat* th, int reg, u8 data)
	98	{
	99	u8 tmp[2];
	100	int rc;
	101
	102	tmp[0] = reg;
	103	tmp[1] = data;
	104	rc = i2c_master_send(&th->clt, (const char *)tmp, 2);
	105	if (rc < 0)
	106	return rc;
	107	if (rc != 2)
	108	return -ENODEV;
	109	return 0;
	110	}
	111
	112	static int
	113	read_reg(struct thermostat* th, int reg)
	114	{
	115	u8 reg_addr, data;
	116	int rc;
	117
	118	reg_addr = (u8)reg;
	119	rc = i2c_master_send(&th->clt, &reg_addr, 1);
	120	if (rc < 0)
	121	return rc;
	122	if (rc != 1)
	123	return -ENODEV;
	124	rc = i2c_master_recv(&th->clt, (char *)&data, 1);
	125	if (rc < 0)
	126	return rc;
	127	return data;
	128	}
	129
	130	static int
	131	attach_thermostat(struct i2c_adapter *adapter)
	132	{
	133	unsigned long bus_no;
	134
	135	if (strncmp(adapter->name, "uni-n", 5))
	136	return -ENODEV;
	137	bus_no = simple_strtoul(adapter->name + 6, NULL, 10);
138	if (bus_no != therm_bus)
139	return -ENODEV;
140	return attach_one_thermostat(adapter, therm_address, bus_no);
141	}
142
143	static int
144	detach_thermostat(struct i2c_adapter *adapter)
145	{
146	struct thermostat* th;
147	int i;
148
149	if (thermostat == NULL)
150	return 0;
151
152	th = thermostat;
153
154	if (thread_therm != NULL) {
155	kthread_stop(thread_therm);
156	}
9f6d4b0c	157
1da177e4 LT	158	printk(KERN_INFO "adt746x: Putting max temperatures back from "
	159	"%d, %d, %d to %d, %d, %d\n",
	160	th->limits[0], th->limits[1], th->limits[2],
	161	th->initial_limits[0], th->initial_limits[1],
	162	th->initial_limits[2]);
9f6d4b0c	163
1da177e4 LT	164	for (i = 0; i < 3; i++)
	165	write_reg(th, LIMIT_REG[i], th->initial_limits[i]);
	166
	167	write_both_fan_speed(th, -1);
	168
	169	i2c_detach_client(&th->clt);
	170
	171	thermostat = NULL;
	172
	173	kfree(th);
	174
	175	return 0;
	176	}
	177
	178	static struct i2c_driver thermostat_driver = {
a33ca232	179	.driver = {
a33ca232 LR	180	.name = "therm_adt746x",
a33ca232 LR	181	},
1da177e4 LT	182	.attach_adapter = attach_thermostat,
	183	.detach_adapter = detach_thermostat,
	184	};
	185
	186	static int read_fan_speed(struct thermostat *th, u8 addr)
	187	{
	188	u8 tmp[2];
	189	u16 res;
	190
	191	/* should start with low byte */
	192	tmp[1] = read_reg(th, addr);
	193	tmp[0] = read_reg(th, addr + 1);
	194
	195	res = tmp[1] + (tmp[0] << 8);
	196	/* "a value of 0xffff means that the fan has stopped" */
	197	return (res == 0xffff ? 0 : (90000*60)/res);
	198	}
	199
	200	static void write_both_fan_speed(struct thermostat *th, int speed)
	201	{
	202	write_fan_speed(th, speed, 0);
	203	if (therm_type == ADT7460)
	204	write_fan_speed(th, speed, 1);
	205	}
	206
	207	static void write_fan_speed(struct thermostat *th, int speed, int fan)
	208	{
	209	u8 manual;
	210
	211	if (speed > 0xff)
	212	speed = 0xff;
	213	else if (speed < -1)
	214	speed = 0;
	215
	216	if (therm_type == ADT7467 && fan == 1)
	217	return;
	218
	219	if (th->last_speed[fan] != speed) {
9f6d4b0c BC	220	if (verbose) {
	221	if (speed == -1)
	222	printk(KERN_DEBUG "adt746x: Setting speed to automatic "
	223	"for %s fan.\n", sensor_location[fan+1]);
	224	else
	225	printk(KERN_DEBUG "adt746x: Setting speed to %d "
	226	"for %s fan.\n", speed, sensor_location[fan+1]);
	227	}
1da177e4 LT	228	} else
	229	return;
	230
	231	if (speed >= 0) {
	232	manual = read_reg(th, MANUAL_MODE[fan]);
	233	write_reg(th, MANUAL_MODE[fan], manual\|MANUAL_MASK);
	234	write_reg(th, FAN_SPD_SET[fan], speed);
	235	} else {
	236	/* back to automatic */
	237	if(therm_type == ADT7460) {
	238	manual = read_reg(th,
	239	MANUAL_MODE[fan]) & (~MANUAL_MASK);
	240
	241	write_reg(th,
	242	MANUAL_MODE[fan], manual\|REM_CONTROL[fan]);
	243	} else {
	244	manual = read_reg(th, MANUAL_MODE[fan]);
	245	write_reg(th, MANUAL_MODE[fan], manual&(~AUTO_MASK));
	246	}
	247	}
	248
	249	th->last_speed[fan] = speed;
	250	}
	251
	252	static void read_sensors(struct thermostat *th)
	253	{
	254	int i = 0;
	255
	256	for (i = 0; i < 3; i++)
	257	th->temps[i] = read_reg(th, TEMP_REG[i]);
	258	}
	259
	260	#ifdef DEBUG
	261	static void display_stats(struct thermostat *th)
	262	{
	263	if (th->temps[0] != th->cached_temp[0]
	264	\|\| th->temps[1] != th->cached_temp[1]
	265	\|\| th->temps[2] != th->cached_temp[2]) {
	266	printk(KERN_INFO "adt746x: Temperature infos:"
	267	" thermostats: %d,%d,%d;"
	268	" limits: %d,%d,%d;"
	269	" fan speed: %d RPM\n",
	270	th->temps[0], th->temps[1], th->temps[2],
	271	th->limits[0], th->limits[1], th->limits[2],
	272	read_fan_speed(th, FAN_SPEED[0]));
	273	}
	274	th->cached_temp[0] = th->temps[0];
	275	th->cached_temp[1] = th->temps[1];
	276	th->cached_temp[2] = th->temps[2];
	277	}
	278	#endif
	279
	280	static void update_fans_speed (struct thermostat *th)
	281	{
	282	int lastvar = 0; /* last variation, for iBook */
	283	int i = 0;
	284
	285	/* we don't care about local sensor, so we start at sensor 1 */
	286	for (i = 1; i < 3; i++) {
	287	int started = 0;
	288	int fan_number = (therm_type == ADT7460 && i == 2);
	289	int var = th->temps[i] - th->limits[i];
	290
	291	if (var > -1) {
292	int step = (255 - fan_speed) / 7;
293	int new_speed = 0;
294
295	/* hysteresis : change fan speed only if variation is
296	* more than two degrees */
297	if (abs(var - th->last_var[fan_number]) < 2)
298	continue;
299
300	started = 1;
301	new_speed = fan_speed + ((var-1)*step);
302
303	if (new_speed < fan_speed)
304	new_speed = fan_speed;
305	if (new_speed > 255)
306	new_speed = 255;
307
9f6d4b0c BC	308	if (verbose)
	309	printk(KERN_DEBUG "adt746x: Setting fans speed to %d "
	310	"(limit exceeded by %d on %s) \n",
	311	new_speed, var,
	312	sensor_location[fan_number+1]);
1da177e4 LT	313	write_both_fan_speed(th, new_speed);
	314	th->last_var[fan_number] = var;
	315	} else if (var < -2) {
d20c507f	316	/* don't stop fan if sensor2 is cold and sensor1 is not
1da177e4 LT	317	* so cold (lastvar >= -1) */
	318	if (i == 2 && lastvar < -1) {
	319	if (th->last_speed[fan_number] != 0)
9f6d4b0c BC	320	if (verbose)
	321	printk(KERN_DEBUG "adt746x: Stopping "
	322	"fans.\n");
1da177e4 LT	323	write_both_fan_speed(th, 0);
	324	}
	325	}
	326
	327	lastvar = var;
	328
	329	if (started)
	330	return; /* we don't want to re-stop the fan
d20c507f	331	* if sensor1 is heating and sensor2 is not */
1da177e4 LT	332	}
	333	}
	334
	335	static int monitor_task(void *arg)
	336	{
	337	struct thermostat* th = arg;
	338
	339	while(!kthread_should_stop()) {
3e1d1d28	340	try_to_freeze();
1da177e4 LT	341	msleep_interruptible(2000);
	342
	343	#ifndef DEBUG
	344	if (fan_speed != -1)
	345	read_sensors(th);
	346	#else
	347	read_sensors(th);
	348	#endif
	349
	350	if (fan_speed != -1)
	351	update_fans_speed(th);
	352
	353	#ifdef DEBUG
	354	display_stats(th);
	355	#endif
	356
	357	}
	358
	359	return 0;
	360	}
	361
	362	static void set_limit(struct thermostat *th, int i)
	363	{
d20c507f	364	/* Set sensor1 limit higher to avoid powerdowns */
1da177e4 LT	365	th->limits[i] = default_limits_chip[i] + limit_adjust;
	366	write_reg(th, LIMIT_REG[i], th->limits[i]);
	367
	368	/* set our limits to normal */
	369	th->limits[i] = default_limits_local[i] + limit_adjust;
	370	}
	371
	372	static int attach_one_thermostat(struct i2c_adapter *adapter, int addr,
	373	int busno)
	374	{
	375	struct thermostat* th;
	376	int rc;
	377	int i;
	378
	379	if (thermostat)
	380	return 0;
	381
	382	th = (struct thermostat *)
	383	kmalloc(sizeof(struct thermostat), GFP_KERNEL);
	384
	385	if (!th)
	386	return -ENOMEM;
	387
	388	memset(th, 0, sizeof(*th));
	389	th->clt.addr = addr;
	390	th->clt.adapter = adapter;
	391	th->clt.driver = &thermostat_driver;
	392	strcpy(th->clt.name, "thermostat");
	393
	394	rc = read_reg(th, 0);
	395	if (rc < 0) {
	396	printk(KERN_ERR "adt746x: Thermostat failed to read config "
	397	"from bus %d !\n",
	398	busno);
	399	kfree(th);
	400	return -ENODEV;
	401	}
	402
	403	/* force manual control to start the fan quieter */
	404	if (fan_speed == -1)
	405	fan_speed = 64;
	406
	407	if(therm_type == ADT7460) {
	408	printk(KERN_INFO "adt746x: ADT7460 initializing\n");
	409	/* The 7460 needs to be started explicitly */
	410	write_reg(th, CONFIG_REG, 1);
	411	} else
	412	printk(KERN_INFO "adt746x: ADT7467 initializing\n");
	413
	414	for (i = 0; i < 3; i++) {
	415	th->initial_limits[i] = read_reg(th, LIMIT_REG[i]);
	416	set_limit(th, i);
	417	}
9f6d4b0c	418
1da177e4 LT	419	printk(KERN_INFO "adt746x: Lowering max temperatures from %d, %d, %d"
	420	" to %d, %d, %d\n",
	421	th->initial_limits[0], th->initial_limits[1],
	422	th->initial_limits[2], th->limits[0], th->limits[1],
	423	th->limits[2]);
	424
	425	thermostat = th;
	426
	427	if (i2c_attach_client(&th->clt)) {
	428	printk(KERN_INFO "adt746x: Thermostat failed to attach "
	429	"client !\n");
	430	thermostat = NULL;
	431	kfree(th);
	432	return -ENODEV;
	433	}
	434
	435	/* be sure to really write fan speed the first time */
	436	th->last_speed[0] = -2;
	437	th->last_speed[1] = -2;
	438	th->last_var[0] = -80;
	439	th->last_var[1] = -80;
	440
	441	if (fan_speed != -1) {
	442	/* manual mode, stop fans */
	443	write_both_fan_speed(th, 0);
	444	} else {
	445	/* automatic mode */
	446	write_both_fan_speed(th, -1);
	447	}
	448
	449	thread_therm = kthread_run(monitor_task, th, "kfand");
	450
	451	if (thread_therm == ERR_PTR(-ENOMEM)) {
	452	printk(KERN_INFO "adt746x: Kthread creation failed\n");
	453	thread_therm = NULL;
	454	return -ENOMEM;
	455	}
	456
	457	return 0;
	458	}
	459
	460	/*
	461	* Now, unfortunately, sysfs doesn't give us a nice void * we could
	462	* pass around to the attribute functions, so we don't really have
	463	* choice but implement a bunch of them...
	464	*
e404e274	465	* FIXME, it does now...
1da177e4 LT	466	*/
1da177e4 LT	467	#define BUILD_SHOW_FUNC_INT(name, data) \
e404e274	468	static ssize_t show_##name(struct device dev, struct device_attribute attr, char *buf) \
1da177e4 LT	469	{ \
	470	return sprintf(buf, "%d\n", data); \
	471	}
	472
d20c507f	473	#define BUILD_SHOW_FUNC_STR(name, data) \
e404e274	474	static ssize_t show_##name(struct device dev, struct device_attribute attr, char *buf) \
d20c507f CL	475	{ \
	476	return sprintf(buf, "%s\n", data); \
	477	}
	478
1da177e4	479	#define BUILD_SHOW_FUNC_FAN(name, data) \
e404e274	480	static ssize_t show_##name(struct device dev, struct device_attribute attr, char *buf) \
1da177e4 LT	481	{ \
	482	return sprintf(buf, "%d (%d rpm)\n", \
	483	thermostat->last_speed[data], \
	484	read_fan_speed(thermostat, FAN_SPEED[data]) \
	485	); \
	486	}
	487
	488	#define BUILD_STORE_FUNC_DEG(name, data) \
e404e274	489	static ssize_t store_##name(struct device dev, struct device_attribute attr, const char *buf, size_t n) \
1da177e4 LT	490	{ \
	491	int val; \
	492	int i; \
	493	val = simple_strtol(buf, NULL, 10); \
d20c507f	494	printk(KERN_INFO "Adjusting limits by %d degrees\n", val); \
1da177e4 LT	495	limit_adjust = val; \
	496	for (i=0; i < 3; i++) \
	497	set_limit(thermostat, i); \
	498	return n; \
	499	}
	500
	501	#define BUILD_STORE_FUNC_INT(name, data) \
e404e274	502	static ssize_t store_##name(struct device dev, struct device_attribute attr, const char *buf, size_t n) \
1da177e4 LT	503	{ \
	504	u32 val; \
	505	val = simple_strtoul(buf, NULL, 10); \
	506	if (val < 0 \|\| val > 255) \
	507	return -EINVAL; \
	508	printk(KERN_INFO "Setting specified fan speed to %d\n", val); \
	509	data = val; \
	510	return n; \
	511	}
	512
d20c507f CL	513	BUILD_SHOW_FUNC_INT(sensor1_temperature, (read_reg(thermostat, TEMP_REG[1])))
	514	BUILD_SHOW_FUNC_INT(sensor2_temperature, (read_reg(thermostat, TEMP_REG[2])))
	515	BUILD_SHOW_FUNC_INT(sensor1_limit, thermostat->limits[1])
	516	BUILD_SHOW_FUNC_INT(sensor2_limit, thermostat->limits[2])
	517	BUILD_SHOW_FUNC_STR(sensor1_location, sensor_location[1])
	518	BUILD_SHOW_FUNC_STR(sensor2_location, sensor_location[2])
1da177e4 LT	519
1da177e4 LT	520	BUILD_SHOW_FUNC_INT(specified_fan_speed, fan_speed)
d20c507f CL	521	BUILD_SHOW_FUNC_FAN(sensor1_fan_speed, 0)
d20c507f CL	522	BUILD_SHOW_FUNC_FAN(sensor2_fan_speed, 1)
1da177e4 LT	523
	524	BUILD_STORE_FUNC_INT(specified_fan_speed,fan_speed)
	525	BUILD_SHOW_FUNC_INT(limit_adjust, limit_adjust)
	526	BUILD_STORE_FUNC_DEG(limit_adjust, thermostat)
	527
d20c507f CL	528	static DEVICE_ATTR(sensor1_temperature, S_IRUGO,
	529	show_sensor1_temperature,NULL);
	530	static DEVICE_ATTR(sensor2_temperature, S_IRUGO,
	531	show_sensor2_temperature,NULL);
	532	static DEVICE_ATTR(sensor1_limit, S_IRUGO,
	533	show_sensor1_limit, NULL);
	534	static DEVICE_ATTR(sensor2_limit, S_IRUGO,
	535	show_sensor2_limit, NULL);
	536	static DEVICE_ATTR(sensor1_location, S_IRUGO,
	537	show_sensor1_location, NULL);
	538	static DEVICE_ATTR(sensor2_location, S_IRUGO,
	539	show_sensor2_location, NULL);
1da177e4 LT	540
	541	static DEVICE_ATTR(specified_fan_speed, S_IRUSR\|S_IWUSR\|S_IRGRP\|S_IROTH,
	542	show_specified_fan_speed,store_specified_fan_speed);
	543
d20c507f CL	544	static DEVICE_ATTR(sensor1_fan_speed, S_IRUGO,
	545	show_sensor1_fan_speed, NULL);
	546	static DEVICE_ATTR(sensor2_fan_speed, S_IRUGO,
	547	show_sensor2_fan_speed, NULL);
1da177e4 LT	548
	549	static DEVICE_ATTR(limit_adjust, S_IRUSR\|S_IWUSR\|S_IRGRP\|S_IROTH,
	550	show_limit_adjust, store_limit_adjust);
	551
	552
	553	static int __init
	554	thermostat_init(void)
	555	{
	556	struct device_node* np;
018a3d1d	557	const u32 *prop;
d20c507f	558	int i = 0, offset = 0;
1da177e4 LT	559
	560	np = of_find_node_by_name(NULL, "fan");
	561	if (!np)
	562	return -ENODEV;
	563	if (device_is_compatible(np, "adt7460"))
	564	therm_type = ADT7460;
	565	else if (device_is_compatible(np, "adt7467"))
	566	therm_type = ADT7467;
	567	else
	568	return -ENODEV;
a8bacec0	569
018a3d1d	570	prop = get_property(np, "hwsensor-params-version", NULL);
a8bacec0 CL	571	printk(KERN_INFO "adt746x: version %d (%ssupported)\n", *prop,
	572	(*prop == 1)?"":"un");
	573	if (*prop != 1)
	574	return -ENODEV;
1da177e4	575
018a3d1d	576	prop = get_property(np, "reg", NULL);
1da177e4 LT	577	if (!prop)
	578	return -ENODEV;
	579
	580	/* look for bus either by path or using "reg" */
	581	if (strstr(np->full_name, "/i2c-bus@") != NULL) {
	582	const char *tmp_bus = (strstr(np->full_name, "/i2c-bus@") + 9);
	583	therm_bus = tmp_bus[0]-'0';
	584	} else {
	585	therm_bus = ((*prop) >> 8) & 0x0f;
	586	}
	587
	588	therm_address = ((*prop) & 0xff) >> 1;
	589
	590	printk(KERN_INFO "adt746x: Thermostat bus: %d, address: 0x%02x, "
	591	"limit_adjust: %d, fan_speed: %d\n",
	592	therm_bus, therm_address, limit_adjust, fan_speed);
	593
d20c507f CL	594	if (get_property(np, "hwsensor-location", NULL)) {
	595	for (i = 0; i < 3; i++) {
	596	sensor_location[i] = get_property(np,
	597	"hwsensor-location", NULL) + offset;
	598
	599	if (sensor_location[i] == NULL)
	600	sensor_location[i] = "";
	601
	602	printk(KERN_INFO "sensor %d: %s\n", i, sensor_location[i]);
	603	offset += strlen(sensor_location[i]) + 1;
	604	}
	605	} else {
	606	sensor_location[0] = "?";
	607	sensor_location[1] = "?";
	608	sensor_location[2] = "?";
	609	}
	610
0365ba7f	611	of_dev = of_platform_device_create(np, "temperatures", NULL);
1da177e4 LT	612
	613	if (of_dev == NULL) {
	614	printk(KERN_ERR "Can't register temperatures device !\n");
	615	return -ENODEV;
	616	}
	617
d20c507f CL	618	device_create_file(&of_dev->dev, &dev_attr_sensor1_temperature);
	619	device_create_file(&of_dev->dev, &dev_attr_sensor2_temperature);
	620	device_create_file(&of_dev->dev, &dev_attr_sensor1_limit);
	621	device_create_file(&of_dev->dev, &dev_attr_sensor2_limit);
	622	device_create_file(&of_dev->dev, &dev_attr_sensor1_location);
	623	device_create_file(&of_dev->dev, &dev_attr_sensor2_location);
1da177e4 LT	624	device_create_file(&of_dev->dev, &dev_attr_limit_adjust);
1da177e4 LT	625	device_create_file(&of_dev->dev, &dev_attr_specified_fan_speed);
d20c507f	626	device_create_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
1da177e4	627	if(therm_type == ADT7460)
d20c507f	628	device_create_file(&of_dev->dev, &dev_attr_sensor2_fan_speed);
1da177e4	629
4d6c5889 BH	630	#ifndef CONFIG_I2C_POWERMAC
4d6c5889 BH	631	request_module("i2c-powermac");
1da177e4 LT	632	#endif
	633
	634	return i2c_add_driver(&thermostat_driver);
	635	}
	636
	637	static void __exit
	638	thermostat_exit(void)
	639	{
	640	if (of_dev) {
d20c507f CL	641	device_remove_file(&of_dev->dev, &dev_attr_sensor1_temperature);
	642	device_remove_file(&of_dev->dev, &dev_attr_sensor2_temperature);
	643	device_remove_file(&of_dev->dev, &dev_attr_sensor1_limit);
	644	device_remove_file(&of_dev->dev, &dev_attr_sensor2_limit);
	645	device_remove_file(&of_dev->dev, &dev_attr_sensor1_location);
	646	device_remove_file(&of_dev->dev, &dev_attr_sensor2_location);
1da177e4 LT	647	device_remove_file(&of_dev->dev, &dev_attr_limit_adjust);
1da177e4 LT	648	device_remove_file(&of_dev->dev, &dev_attr_specified_fan_speed);
d20c507f	649	device_remove_file(&of_dev->dev, &dev_attr_sensor1_fan_speed);
1da177e4 LT	650
	651	if(therm_type == ADT7460)
	652	device_remove_file(&of_dev->dev,
d20c507f	653	&dev_attr_sensor2_fan_speed);
1da177e4 LT	654
	655	of_device_unregister(of_dev);
	656	}
	657	i2c_del_driver(&thermostat_driver);
	658	}
	659
	660	module_init(thermostat_init);
	661	module_exit(thermostat_exit);