[linux-block.git] / drivers / macintosh / therm_adt746x.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * 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 115254175ADT7467_pra.pdf and 3686221171167ADT7460_b.pdf
 * https://www.onsemi.com/PowerSolutions/product.do?id=ADT7467
 * https://www.onsemi.com/PowerSolutions/product.do?id=ADT7460
 *
 */

#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/wait.h>
#include <linux/suspend.h>
#include <linux/kthread.h>
#include <linux/moduleparam.h>
#include <linux/freezer.h>
#include <linux/of.h>
#include <linux/of_platform.h>
#include <linux/platform_device.h>

#include <asm/machdep.h>
#include <asm/io.h>
#include <asm/sections.h>

#undef DEBUG

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

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] = { "?", "?", "?" };

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

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];
	int			pwm_inv[2];
	struct task_struct	*thread;
	struct platform_device	*pdev;
	enum {
		ADT7460,
		ADT7467
	}			type;
};

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 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 (th->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 (th->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]);
		manual &= ~INVERT_MASK;
		write_reg(th, MANUAL_MODE[fan],
			manual | MANUAL_MASK | th->pwm_inv[fan]);
		write_reg(th, FAN_SPD_SET[fan], speed);
	} else {
		/* back to automatic */
		if(th->type == ADT7460) {
			manual = read_reg(th,
				MANUAL_MODE[fan]) & (~MANUAL_MASK);
			manual &= ~INVERT_MASK;
			manual |= th->pwm_inv[fan];
			write_reg(th,
				MANUAL_MODE[fan], manual|REM_CONTROL[fan]);
		} else {
			manual = read_reg(th, MANUAL_MODE[fan]);
			manual &= ~INVERT_MASK;
			manual |= th->pwm_inv[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++) {
		bool started = false;
		int fan_number = (th->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 = true;
			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;

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

#define BUILD_SHOW_FUNC_INT(name, data)				\
static ssize_t show_##name(struct device *dev, struct device_attribute *attr, char *buf)	\
{								\
	struct thermostat *th = dev_get_drvdata(dev);		\
	return sprintf(buf, "%d\n", data);			\
}

#define BUILD_SHOW_FUNC_INT_LITE(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)       \
{								\
	struct thermostat *th = dev_get_drvdata(dev);		\
	return sprintf(buf, "%d (%d rpm)\n", 			\
		th->last_speed[data],				\
		read_fan_speed(th, 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) \
{								\
	struct thermostat *th = dev_get_drvdata(dev);		\
	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(th, 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) \
{								\
	int val;						\
	val = simple_strtol(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(th, TEMP_REG[1])))
BUILD_SHOW_FUNC_INT(sensor2_temperature,	 (read_reg(th, TEMP_REG[2])))
BUILD_SHOW_FUNC_INT(sensor1_limit,		 th->limits[1])
BUILD_SHOW_FUNC_INT(sensor2_limit,		 th->limits[2])
BUILD_SHOW_FUNC_STR(sensor1_location,		 sensor_location[1])
BUILD_SHOW_FUNC_STR(sensor2_location,		 sensor_location[2])

BUILD_SHOW_FUNC_INT_LITE(specified_fan_speed, fan_speed)
BUILD_STORE_FUNC_INT(specified_fan_speed,fan_speed)

BUILD_SHOW_FUNC_FAN(sensor1_fan_speed,	 0)
BUILD_SHOW_FUNC_FAN(sensor2_fan_speed,	 1)

BUILD_SHOW_FUNC_INT_LITE(limit_adjust,	 limit_adjust)
BUILD_STORE_FUNC_DEG(limit_adjust,	 th)
		
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 void thermostat_create_files(struct thermostat *th)
{
	struct device_node *np = th->clt->dev.of_node;
	struct device *dev;
	int err;

	/* To maintain ABI compatibility with userspace, create
	 * the old style platform driver and attach the attributes
	 * to it here
	 */
	th->pdev = of_platform_device_create(np, "temperatures", NULL);
	if (!th->pdev)
		return;
	dev = &th->pdev->dev;
	dev_set_drvdata(dev, th);
	err = device_create_file(dev, &dev_attr_sensor1_temperature);
	err |= device_create_file(dev, &dev_attr_sensor2_temperature);
	err |= device_create_file(dev, &dev_attr_sensor1_limit);
	err |= device_create_file(dev, &dev_attr_sensor2_limit);
	err |= device_create_file(dev, &dev_attr_sensor1_location);
	err |= device_create_file(dev, &dev_attr_sensor2_location);
	err |= device_create_file(dev, &dev_attr_limit_adjust);
	err |= device_create_file(dev, &dev_attr_specified_fan_speed);
	err |= device_create_file(dev, &dev_attr_sensor1_fan_speed);
	if(th->type == ADT7460)
		err |= device_create_file(dev, &dev_attr_sensor2_fan_speed);
	if (err)
		printk(KERN_WARNING
			"Failed to create temperature attribute file(s).\n");
}

static void thermostat_remove_files(struct thermostat *th)
{
	struct device *dev;

	if (!th->pdev)
		return;
	dev = &th->pdev->dev;
	device_remove_file(dev, &dev_attr_sensor1_temperature);
	device_remove_file(dev, &dev_attr_sensor2_temperature);
	device_remove_file(dev, &dev_attr_sensor1_limit);
	device_remove_file(dev, &dev_attr_sensor2_limit);
	device_remove_file(dev, &dev_attr_sensor1_location);
	device_remove_file(dev, &dev_attr_sensor2_location);
	device_remove_file(dev, &dev_attr_limit_adjust);
	device_remove_file(dev, &dev_attr_specified_fan_speed);
	device_remove_file(dev, &dev_attr_sensor1_fan_speed);	
	if (th->type == ADT7460)
		device_remove_file(dev, &dev_attr_sensor2_fan_speed);
	of_device_unregister(th->pdev);

}

static int probe_thermostat(struct i2c_client *client)
{
	const struct i2c_device_id *id = i2c_client_get_device_id(client);
	struct device_node *np = client->dev.of_node;
	struct thermostat* th;
	const __be32 *prop;
	int i, rc, vers, offset = 0;

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

	if (of_property_present(np, "hwsensor-location")) {
		for (i = 0; i < 3; i++) {
			sensor_location[i] = of_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;
		}
	}

	th = kzalloc(sizeof(struct thermostat), GFP_KERNEL);
	if (!th)
		return -ENOMEM;

	i2c_set_clientdata(client, th);
	th->clt = client;
	th->type = id->driver_data;

	rc = read_reg(th, CONFIG_REG);
	if (rc < 0) {
		dev_err(&client->dev, "Thermostat failed to read config!\n");
		kfree(th);
		return -ENODEV;
	}

	/* force manual control to start the fan quieter */
	if (fan_speed == -1)
		fan_speed = 64;
	
	if (th->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]);

	/* record invert bit status because fw can corrupt it after suspend */
	th->pwm_inv[0] = read_reg(th, MANUAL_MODE[0]) & INVERT_MASK;
	th->pwm_inv[1] = read_reg(th, MANUAL_MODE[1]) & INVERT_MASK;

	/* 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);
	}
	
	th->thread = kthread_run(monitor_task, th, "kfand");
	if (th->thread == ERR_PTR(-ENOMEM)) {
		printk(KERN_INFO "adt746x: Kthread creation failed\n");
		th->thread = NULL;
		return -ENOMEM;
	}

	thermostat_create_files(th);

	return 0;
}

static void remove_thermostat(struct i2c_client *client)
{
	struct thermostat *th = i2c_get_clientdata(client);
	int i;
	
	thermostat_remove_files(th);

	if (th->thread != NULL)
		kthread_stop(th->thread);

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

	kfree(th);
}

static const struct i2c_device_id therm_adt746x_id[] = {
	{ "MAC,adt7460", ADT7460 },
	{ "MAC,adt7467", ADT7467 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, therm_adt746x_id);

static struct i2c_driver thermostat_driver = {
	.driver = {
		.name	= "therm_adt746x",
	},
	.probe = probe_thermostat,
	.remove = remove_thermostat,
	.id_table = therm_adt746x_id,
};

static int __init thermostat_init(void)
{
#ifndef CONFIG_I2C_POWERMAC
	request_module("i2c-powermac");
#endif

	return i2c_add_driver(&thermostat_driver);
}

static void __exit thermostat_exit(void)
{
	i2c_del_driver(&thermostat_driver);
}

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