[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>
 *
 * 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)

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 device *hwmon_dev;
	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 i2c_client *client = to_i2c_client(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(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 i2c_client *client = to_i2c_client(dev);
	int temp;

	s32 err = i2c_smbus_read_word_swapped(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 i2c_client *client = to_i2c_client(dev);
	struct lm73_data *data = i2c_get_clientdata(client);
	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(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 i2c_client *client = to_i2c_client(dev);
	struct lm73_data *data = i2c_get_clientdata(client);
	int res;

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

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

/* 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 struct attribute *lm73_attributes[] = {
	&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,
	NULL
};

static const struct attribute_group lm73_group = {
	.attrs = lm73_attributes,
};

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

/* device probe and removal */

static int
lm73_probe(struct i2c_client *client, const struct i2c_device_id *id)
{
	int status;
	struct lm73_data *data;
	int ctrl;

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

	i2c_set_clientdata(client, data);
	mutex_init(&data->lock);

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

	/* Register sysfs hooks */
	status = sysfs_create_group(&client->dev.kobj, &lm73_group);
	if (status)
		return status;

	data->hwmon_dev = hwmon_device_register(&client->dev);
	if (IS_ERR(data->hwmon_dev)) {
		status = PTR_ERR(data->hwmon_dev);
		goto exit_remove;
	}

	dev_info(&client->dev, "%s: sensor '%s'\n",
		 dev_name(data->hwmon_dev), client->name);

	return 0;

exit_remove:
	sysfs_remove_group(&client->dev.kobj, &lm73_group);
	return status;
}

static int lm73_remove(struct i2c_client *client)
{
	struct lm73_data *data = i2c_get_clientdata(client);

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