[mirror_ubuntu-bionic-kernel.git] / drivers / hwmon / lm73.c

/*
 * LM73 Sensor driver
 * Based on LM75
 *
 * Copyright (C) 2007, CenoSYS (www.cenosys.com).
 * Copyright (C) 2009, Bollore telecom (www.bolloretelecom.eu).
 *
 * Guillaume Ligneul <guillaume.ligneul@gmail.com>
 * Adrien Demarez <adrien.demarez@bolloretelecom.eu>
 * Jeremy Laine <jeremy.laine@bolloretelecom.eu>
 * Chris Verges <kg4ysn@gmail.com>
 *
 * This software program is licensed subject to the GNU General Public License
 * (GPL).Version 2,June 1991, available at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/i2c.h>
#include <linux/hwmon.h>
#include <linux/hwmon-sysfs.h>
#include <linux/err.h>


/* Addresses scanned */
static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4c,
					0x4d, 0x4e, I2C_CLIENT_END };

/* LM73 registers */
#define LM73_REG_INPUT		0x00
#define LM73_REG_CONF		0x01
#define LM73_REG_MAX		0x02
#define LM73_REG_MIN		0x03
#define LM73_REG_CTRL		0x04
#define LM73_REG_ID		0x07

#define LM73_ID			0x9001	/* 0x0190, byte-swapped */
#define DRVNAME			"lm73"
#define LM73_TEMP_MIN		(-256000 / 250)
#define LM73_TEMP_MAX		(255750 / 250)

#define LM73_CTRL_RES_SHIFT	5
#define LM73_CTRL_RES_MASK	(BIT(5) | BIT(6))
#define LM73_CTRL_TO_MASK	BIT(7)

#define LM73_CTRL_HI_SHIFT	2
#define LM73_CTRL_LO_SHIFT	1

static const unsigned short lm73_convrates[] = {
	14,	/* 11-bits (0.25000 C/LSB): RES1 Bit = 0, RES0 Bit = 0 */
	28,	/* 12-bits (0.12500 C/LSB): RES1 Bit = 0, RES0 Bit = 1 */
	56,	/* 13-bits (0.06250 C/LSB): RES1 Bit = 1, RES0 Bit = 0 */
	112,	/* 14-bits (0.03125 C/LSB): RES1 Bit = 1, RES0 Bit = 1 */
};

struct lm73_data {
	struct i2c_client *client;
	struct mutex lock;
	u8 ctrl;			/* control register value */
};

/*-----------------------------------------------------------------------*/

static ssize_t set_temp(struct device *dev, struct device_attribute *da,
			const char *buf, size_t count)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	struct lm73_data *data = dev_get_drvdata(dev);
	long temp;
	short value;
	s32 err;

	int status = kstrtol(buf, 10, &temp);
	if (status < 0)
		return status;

	/* Write value */
	value = clamp_val(temp / 250, LM73_TEMP_MIN, LM73_TEMP_MAX) << 5;
	err = i2c_smbus_write_word_swapped(data->client, attr->index, value);
	return (err < 0) ? err : count;
}

static ssize_t show_temp(struct device *dev, struct device_attribute *da,
			 char *buf)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	struct lm73_data *data = dev_get_drvdata(dev);
	int temp;

	s32 err = i2c_smbus_read_word_swapped(data->client, attr->index);
	if (err < 0)
		return err;

	/* use integer division instead of equivalent right shift to
	   guarantee arithmetic shift and preserve the sign */
	temp = (((s16) err) * 250) / 32;
	return scnprintf(buf, PAGE_SIZE, "%d\n", temp);
}

static ssize_t set_convrate(struct device *dev, struct device_attribute *da,
			    const char *buf, size_t count)
{
	struct lm73_data *data = dev_get_drvdata(dev);
	unsigned long convrate;
	s32 err;
	int res = 0;

	err = kstrtoul(buf, 10, &convrate);
	if (err < 0)
		return err;

	/*
	 * Convert the desired conversion rate into register bits.
	 * res is already initialized, and everything past the second-to-last
	 * value in the array is treated as belonging to the last value
	 * in the array.
	 */
	while (res < (ARRAY_SIZE(lm73_convrates) - 1) &&
			convrate > lm73_convrates[res])
		res++;

	mutex_lock(&data->lock);
	data->ctrl &= LM73_CTRL_TO_MASK;
	data->ctrl |= res << LM73_CTRL_RES_SHIFT;
	err = i2c_smbus_write_byte_data(data->client, LM73_REG_CTRL,
					data->ctrl);
	mutex_unlock(&data->lock);

	if (err < 0)
		return err;

	return count;
}

static ssize_t show_convrate(struct device *dev, struct device_attribute *da,
			     char *buf)
{
	struct lm73_data *data = dev_get_drvdata(dev);
	int res;

	res = (data->ctrl & LM73_CTRL_RES_MASK) >> LM73_CTRL_RES_SHIFT;
	return scnprintf(buf, PAGE_SIZE, "%hu\n", lm73_convrates[res]);
}

static ssize_t show_maxmin_alarm(struct device *dev,
				 struct device_attribute *da, char *buf)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	struct lm73_data *data = dev_get_drvdata(dev);
	s32 ctrl;

	mutex_lock(&data->lock);
	ctrl = i2c_smbus_read_byte_data(data->client, LM73_REG_CTRL);
	if (ctrl < 0)
		goto abort;
	data->ctrl = ctrl;
	mutex_unlock(&data->lock);

	return scnprintf(buf, PAGE_SIZE, "%d\n", (ctrl >> attr->index) & 1);

abort:
	mutex_unlock(&data->lock);
	return ctrl;
}

/*-----------------------------------------------------------------------*/

/* sysfs attributes for hwmon */

static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO,
			show_temp, set_temp, LM73_REG_MAX);
static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO,
			show_temp, set_temp, LM73_REG_MIN);
static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO,
			show_temp, NULL, LM73_REG_INPUT);
static SENSOR_DEVICE_ATTR(update_interval, S_IWUSR | S_IRUGO,
			show_convrate, set_convrate, 0);
static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO,
			show_maxmin_alarm, NULL, LM73_CTRL_HI_SHIFT);
static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO,
			show_maxmin_alarm, NULL, LM73_CTRL_LO_SHIFT);

static struct attribute *lm73_attrs[] = {
	&sensor_dev_attr_temp1_input.dev_attr.attr,
	&sensor_dev_attr_temp1_max.dev_attr.attr,
	&sensor_dev_attr_temp1_min.dev_attr.attr,
	&sensor_dev_attr_update_interval.dev_attr.attr,
	&sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
	&sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
	NULL
};
ATTRIBUTE_GROUPS(lm73);

/*-----------------------------------------------------------------------*/

/* device probe and removal */

static int
lm73_probe(struct i2c_client *client, const struct i2c_device_id *id)
{
	struct device *dev = &client->dev;
	struct device *hwmon_dev;
	struct lm73_data *data;
	int ctrl;

	data = devm_kzalloc(dev, sizeof(struct lm73_data), GFP_KERNEL);
	if (!data)
		return -ENOMEM;

	data->client = client;
	mutex_init(&data->lock);

	ctrl = i2c_smbus_read_byte_data(client, LM73_REG_CTRL);
	if (ctrl < 0)
		return ctrl;
	data->ctrl = ctrl;

	hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
							   data, lm73_groups);
	if (IS_ERR(hwmon_dev))
		return PTR_ERR(hwmon_dev);

	dev_info(dev, "sensor '%s'\n", client->name);

	return 0;
}

static const struct i2c_device_id lm73_ids[] = {
	{ "lm73", 0 },
	{ /* LIST END */ }
};
MODULE_DEVICE_TABLE(i2c, lm73_ids);

/* Return 0 if detection is successful, -ENODEV otherwise */
static int lm73_detect(struct i2c_client *new_client,
			struct i2c_board_info *info)
{
	struct i2c_adapter *adapter = new_client->adapter;
	int id, ctrl, conf;

	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
					I2C_FUNC_SMBUS_WORD_DATA))
		return -ENODEV;

	/*
	 * Do as much detection as possible with byte reads first, as word
	 * reads can confuse other devices.
	 */
	ctrl = i2c_smbus_read_byte_data(new_client, LM73_REG_CTRL);
	if (ctrl < 0 || (ctrl & 0x10))
		return -ENODEV;

	conf = i2c_smbus_read_byte_data(new_client, LM73_REG_CONF);
	if (conf < 0 || (conf & 0x0c))
		return -ENODEV;

	id = i2c_smbus_read_byte_data(new_client, LM73_REG_ID);
	if (id < 0 || id != (LM73_ID & 0xff))
		return -ENODEV;

	/* Check device ID */
	id = i2c_smbus_read_word_data(new_client, LM73_REG_ID);
	if (id < 0 || id != LM73_ID)
		return -ENODEV;

	strlcpy(info->type, "lm73", I2C_NAME_SIZE);

	return 0;
}

static struct i2c_driver lm73_driver = {
	.class		= I2C_CLASS_HWMON,
	.driver = {
		.name	= "lm73",
	},
	.probe		= lm73_probe,
	.id_table	= lm73_ids,
	.detect		= lm73_detect,
	.address_list	= normal_i2c,
};

module_i2c_driver(lm73_driver);

MODULE_AUTHOR("Guillaume Ligneul <guillaume.ligneul@gmail.com>");
MODULE_DESCRIPTION("LM73 driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
4e233cbe AD	1	/*
	2	* LM73 Sensor driver
	3	* Based on LM75
	4	*
	5	* Copyright (C) 2007, CenoSYS (www.cenosys.com).
	6	* Copyright (C) 2009, Bollore telecom (www.bolloretelecom.eu).
	7	*
	8	* Guillaume Ligneul <guillaume.ligneul@gmail.com>
	9	* Adrien Demarez <adrien.demarez@bolloretelecom.eu>
	10	* Jeremy Laine <jeremy.laine@bolloretelecom.eu>
2bf9233a	11	* Chris Verges <kg4ysn@gmail.com>
4e233cbe AD	12	*
	13	* This software program is licensed subject to the GNU General Public License
	14	* (GPL).Version 2,June 1991, available at
	15	* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
	16	*/
	17
	18	#include <linux/module.h>
	19	#include <linux/init.h>
4e233cbe AD	20	#include <linux/i2c.h>
	21	#include <linux/hwmon.h>
	22	#include <linux/hwmon-sysfs.h>
	23	#include <linux/err.h>
	24
	25
	26	/* Addresses scanned */
	27	static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4c,
	28	0x4d, 0x4e, I2C_CLIENT_END };
	29
4e233cbe AD	30	/* LM73 registers */
	31	#define LM73_REG_INPUT 0x00
	32	#define LM73_REG_CONF 0x01
	33	#define LM73_REG_MAX 0x02
	34	#define LM73_REG_MIN 0x03
	35	#define LM73_REG_CTRL 0x04
	36	#define LM73_REG_ID 0x07
	37
90f4102c	38	#define LM73_ID 0x9001 /* 0x0190, byte-swapped */
4e233cbe	39	#define DRVNAME "lm73"
91bba688 GR	40	#define LM73_TEMP_MIN (-256000 / 250)
91bba688 GR	41	#define LM73_TEMP_MAX (255750 / 250)
4e233cbe	42
8c14d126 CV	43	#define LM73_CTRL_RES_SHIFT 5
	44	#define LM73_CTRL_RES_MASK (BIT(5) \| BIT(6))
	45	#define LM73_CTRL_TO_MASK BIT(7)
	46
2bf9233a CV	47	#define LM73_CTRL_HI_SHIFT 2
	48	#define LM73_CTRL_LO_SHIFT 1
	49
8c14d126 CV	50	static const unsigned short lm73_convrates[] = {
	51	14, /* 11-bits (0.25000 C/LSB): RES1 Bit = 0, RES0 Bit = 0 */
	52	28, /* 12-bits (0.12500 C/LSB): RES1 Bit = 0, RES0 Bit = 1 */
	53	56, /* 13-bits (0.06250 C/LSB): RES1 Bit = 1, RES0 Bit = 0 */
	54	112, /* 14-bits (0.03125 C/LSB): RES1 Bit = 1, RES0 Bit = 1 */
	55	};
	56
	57	struct lm73_data {
3710263f	58	struct i2c_client *client;
8c14d126 CV	59	struct mutex lock;
	60	u8 ctrl; /* control register value */
	61	};
4e233cbe	62
8c14d126	63	/-----------------------------------------------------------------------/
4e233cbe AD	64
	65	static ssize_t set_temp(struct device dev, struct device_attribute da,
	66	const char *buf, size_t count)
	67	{
	68	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
3710263f	69	struct lm73_data *data = dev_get_drvdata(dev);
4e233cbe AD	70	long temp;
4e233cbe AD	71	short value;
0602934f	72	s32 err;
4e233cbe	73
179c4fdb	74	int status = kstrtol(buf, 10, &temp);
4e233cbe AD	75	if (status < 0)
	76	return status;
	77
	78	/* Write value */
91bba688	79	value = clamp_val(temp / 250, LM73_TEMP_MIN, LM73_TEMP_MAX) << 5;
3710263f	80	err = i2c_smbus_write_word_swapped(data->client, attr->index, value);
0602934f	81	return (err < 0) ? err : count;
4e233cbe AD	82	}
	83
	84	static ssize_t show_temp(struct device dev, struct device_attribute da,
	85	char *buf)
	86	{
	87	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
3710263f	88	struct lm73_data *data = dev_get_drvdata(dev);
0602934f CV	89	int temp;
0602934f CV	90
3710263f	91	s32 err = i2c_smbus_read_word_swapped(data->client, attr->index);
0602934f CV	92	if (err < 0)
	93	return err;
	94
4e233cbe AD	95	/* use integer division instead of equivalent right shift to
4e233cbe AD	96	guarantee arithmetic shift and preserve the sign */
0602934f CV	97	temp = (((s16) err) * 250) / 32;
0602934f CV	98	return scnprintf(buf, PAGE_SIZE, "%d\n", temp);
4e233cbe AD	99	}
4e233cbe AD	100
8c14d126 CV	101	static ssize_t set_convrate(struct device dev, struct device_attribute da,
	102	const char *buf, size_t count)
	103	{
3710263f	104	struct lm73_data *data = dev_get_drvdata(dev);
8c14d126 CV	105	unsigned long convrate;
	106	s32 err;
	107	int res = 0;
	108
	109	err = kstrtoul(buf, 10, &convrate);
	110	if (err < 0)
	111	return err;
	112
	113	/*
	114	* Convert the desired conversion rate into register bits.
	115	* res is already initialized, and everything past the second-to-last
	116	* value in the array is treated as belonging to the last value
	117	* in the array.
	118	*/
	119	while (res < (ARRAY_SIZE(lm73_convrates) - 1) &&
	120	convrate > lm73_convrates[res])
	121	res++;
	122
	123	mutex_lock(&data->lock);
	124	data->ctrl &= LM73_CTRL_TO_MASK;
	125	data->ctrl \|= res << LM73_CTRL_RES_SHIFT;
3710263f GR	126	err = i2c_smbus_write_byte_data(data->client, LM73_REG_CTRL,
3710263f GR	127	data->ctrl);
8c14d126 CV	128	mutex_unlock(&data->lock);
	129
	130	if (err < 0)
	131	return err;
	132
	133	return count;
	134	}
	135
	136	static ssize_t show_convrate(struct device dev, struct device_attribute da,
	137	char *buf)
	138	{
3710263f	139	struct lm73_data *data = dev_get_drvdata(dev);
8c14d126 CV	140	int res;
	141
	142	res = (data->ctrl & LM73_CTRL_RES_MASK) >> LM73_CTRL_RES_SHIFT;
	143	return scnprintf(buf, PAGE_SIZE, "%hu\n", lm73_convrates[res]);
	144	}
4e233cbe	145
2bf9233a CV	146	static ssize_t show_maxmin_alarm(struct device *dev,
	147	struct device_attribute da, char buf)
	148	{
2bf9233a	149	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
3710263f	150	struct lm73_data *data = dev_get_drvdata(dev);
2bf9233a CV	151	s32 ctrl;
	152
	153	mutex_lock(&data->lock);
3710263f	154	ctrl = i2c_smbus_read_byte_data(data->client, LM73_REG_CTRL);
2bf9233a CV	155	if (ctrl < 0)
	156	goto abort;
	157	data->ctrl = ctrl;
	158	mutex_unlock(&data->lock);
	159
	160	return scnprintf(buf, PAGE_SIZE, "%d\n", (ctrl >> attr->index) & 1);
	161
	162	abort:
	163	mutex_unlock(&data->lock);
	164	return ctrl;
	165	}
	166
4e233cbe AD	167	/-----------------------------------------------------------------------/
	168
	169	/* sysfs attributes for hwmon */
	170
	171	static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR \| S_IRUGO,
	172	show_temp, set_temp, LM73_REG_MAX);
	173	static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR \| S_IRUGO,
	174	show_temp, set_temp, LM73_REG_MIN);
	175	static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO,
	176	show_temp, NULL, LM73_REG_INPUT);
8c14d126 CV	177	static SENSOR_DEVICE_ATTR(update_interval, S_IWUSR \| S_IRUGO,
8c14d126 CV	178	show_convrate, set_convrate, 0);
2bf9233a CV	179	static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO,
	180	show_maxmin_alarm, NULL, LM73_CTRL_HI_SHIFT);
	181	static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO,
	182	show_maxmin_alarm, NULL, LM73_CTRL_LO_SHIFT);
4e233cbe	183
3710263f	184	static struct attribute *lm73_attrs[] = {
4e233cbe AD	185	&sensor_dev_attr_temp1_input.dev_attr.attr,
	186	&sensor_dev_attr_temp1_max.dev_attr.attr,
	187	&sensor_dev_attr_temp1_min.dev_attr.attr,
8c14d126	188	&sensor_dev_attr_update_interval.dev_attr.attr,
2bf9233a CV	189	&sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
2bf9233a CV	190	&sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
4e233cbe AD	191	NULL
4e233cbe AD	192	};
3710263f	193	ATTRIBUTE_GROUPS(lm73);
4e233cbe AD	194
	195	/-----------------------------------------------------------------------/
	196
	197	/* device probe and removal */
	198
	199	static int
	200	lm73_probe(struct i2c_client client, const struct i2c_device_id id)
	201	{
3710263f GR	202	struct device *dev = &client->dev;
3710263f GR	203	struct device *hwmon_dev;
8c14d126 CV	204	struct lm73_data *data;
	205	int ctrl;
	206
3710263f	207	data = devm_kzalloc(dev, sizeof(struct lm73_data), GFP_KERNEL);
8c14d126 CV	208	if (!data)
	209	return -ENOMEM;
	210
3710263f	211	data->client = client;
8c14d126 CV	212	mutex_init(&data->lock);
	213
	214	ctrl = i2c_smbus_read_byte_data(client, LM73_REG_CTRL);
	215	if (ctrl < 0)
	216	return ctrl;
	217	data->ctrl = ctrl;
4e233cbe	218
3710263f GR	219	hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
	220	data, lm73_groups);
	221	if (IS_ERR(hwmon_dev))
	222	return PTR_ERR(hwmon_dev);
4e233cbe	223
3710263f	224	dev_info(dev, "sensor '%s'\n", client->name);
4e233cbe	225
4e233cbe AD	226	return 0;
	227	}
	228
	229	static const struct i2c_device_id lm73_ids[] = {
1f86df49	230	{ "lm73", 0 },
4e233cbe AD	231	{ /* LIST END */ }
	232	};
	233	MODULE_DEVICE_TABLE(i2c, lm73_ids);
	234
	235	/* Return 0 if detection is successful, -ENODEV otherwise */
310ec792	236	static int lm73_detect(struct i2c_client *new_client,
4e233cbe AD	237	struct i2c_board_info *info)
	238	{
	239	struct i2c_adapter *adapter = new_client->adapter;
24d6e2a8	240	int id, ctrl, conf;
4e233cbe AD	241
	242	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA \|
	243	I2C_FUNC_SMBUS_WORD_DATA))
	244	return -ENODEV;
	245
24d6e2a8 JD	246	/*
	247	* Do as much detection as possible with byte reads first, as word
	248	* reads can confuse other devices.
	249	*/
	250	ctrl = i2c_smbus_read_byte_data(new_client, LM73_REG_CTRL);
	251	if (ctrl < 0 \|\| (ctrl & 0x10))
	252	return -ENODEV;
	253
	254	conf = i2c_smbus_read_byte_data(new_client, LM73_REG_CONF);
	255	if (conf < 0 \|\| (conf & 0x0c))
	256	return -ENODEV;
	257
	258	id = i2c_smbus_read_byte_data(new_client, LM73_REG_ID);
	259	if (id < 0 \|\| id != (LM73_ID & 0xff))
	260	return -ENODEV;
	261
4e233cbe AD	262	/* Check device ID */
4e233cbe AD	263	id = i2c_smbus_read_word_data(new_client, LM73_REG_ID);
24d6e2a8	264	if (id < 0 \|\| id != LM73_ID)
4e233cbe AD	265	return -ENODEV;
	266
	267	strlcpy(info->type, "lm73", I2C_NAME_SIZE);
	268
	269	return 0;
	270	}
	271
	272	static struct i2c_driver lm73_driver = {
	273	.class = I2C_CLASS_HWMON,
	274	.driver = {
	275	.name = "lm73",
	276	},
	277	.probe = lm73_probe,
4e233cbe AD	278	.id_table = lm73_ids,
4e233cbe AD	279	.detect = lm73_detect,
c3813d6a	280	.address_list = normal_i2c,
4e233cbe AD	281	};
4e233cbe AD	282
f0967eea	283	module_i2c_driver(lm73_driver);
4e233cbe AD	284
	285	MODULE_AUTHOR("Guillaume Ligneul <guillaume.ligneul@gmail.com>");
	286	MODULE_DESCRIPTION("LM73 driver");
	287	MODULE_LICENSE("GPL");