[linux.git] / drivers / hwmon / w83l785ts.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * w83l785ts.c - Part of lm_sensors, Linux kernel modules for hardware
 *               monitoring
 * Copyright (C) 2003-2009  Jean Delvare <[email protected]>
 *
 * Inspired from the lm83 driver. The W83L785TS-S is a sensor chip made
 * by Winbond. It reports a single external temperature with a 1 deg
 * resolution and a 3 deg accuracy. Datasheet can be obtained from
 * Winbond's website at:
 *   http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83L785TS-S.pdf
 *
 * Ported to Linux 2.6 by Wolfgang Ziegler <[email protected]> and Jean Delvare
 * <[email protected]>.
 *
 * Thanks to James Bolt <[email protected]> for benchmarking the read
 * error handling mechanism.
 */

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/jiffies.h>
#include <linux/i2c.h>
#include <linux/hwmon.h>
#include <linux/hwmon-sysfs.h>
#include <linux/err.h>
#include <linux/mutex.h>

/* How many retries on register read error */
#define MAX_RETRIES	5

/*
 * Address to scan
 * Address is fully defined internally and cannot be changed.
 */

static const unsigned short normal_i2c[] = { 0x2e, I2C_CLIENT_END };

/*
 * The W83L785TS-S registers
 * Manufacturer ID is 0x5CA3 for Winbond.
 */

#define W83L785TS_REG_MAN_ID1		0x4D
#define W83L785TS_REG_MAN_ID2		0x4C
#define W83L785TS_REG_CHIP_ID		0x4E
#define W83L785TS_REG_CONFIG		0x40
#define W83L785TS_REG_TYPE		0x52
#define W83L785TS_REG_TEMP		0x27
#define W83L785TS_REG_TEMP_OVER		0x53 /* not sure about this one */

/*
 * Conversions
 * The W83L785TS-S uses signed 8-bit values.
 */

#define TEMP_FROM_REG(val)	((val) * 1000)

/*
 * Functions declaration
 */

static int w83l785ts_probe(struct i2c_client *client,
			   const struct i2c_device_id *id);
static int w83l785ts_detect(struct i2c_client *client,
			    struct i2c_board_info *info);
static int w83l785ts_remove(struct i2c_client *client);
static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval);
static struct w83l785ts_data *w83l785ts_update_device(struct device *dev);

/*
 * Driver data (common to all clients)
 */

static const struct i2c_device_id w83l785ts_id[] = {
	{ "w83l785ts", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, w83l785ts_id);

static struct i2c_driver w83l785ts_driver = {
	.class		= I2C_CLASS_HWMON,
	.driver = {
		.name	= "w83l785ts",
	},
	.probe		= w83l785ts_probe,
	.remove		= w83l785ts_remove,
	.id_table	= w83l785ts_id,
	.detect		= w83l785ts_detect,
	.address_list	= normal_i2c,
};

/*
 * Client data (each client gets its own)
 */

struct w83l785ts_data {
	struct device *hwmon_dev;
	struct mutex update_lock;
	char valid; /* zero until following fields are valid */
	unsigned long last_updated; /* in jiffies */

	/* registers values */
	s8 temp[2]; /* 0: input, 1: critical limit */
};

/*
 * Sysfs stuff
 */

static ssize_t show_temp(struct device *dev, struct device_attribute *devattr,
	char *buf)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
	struct w83l785ts_data *data = w83l785ts_update_device(dev);
	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
}

static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 1);

/*
 * Real code
 */

/* Return 0 if detection is successful, -ENODEV otherwise */
static int w83l785ts_detect(struct i2c_client *client,
			    struct i2c_board_info *info)
{
	struct i2c_adapter *adapter = client->adapter;
	u16 man_id;
	u8 chip_id;

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

	/* detection */
	if ((w83l785ts_read_value(client, W83L785TS_REG_CONFIG, 0) & 0x80)
	 || (w83l785ts_read_value(client, W83L785TS_REG_TYPE, 0) & 0xFC)) {
		dev_dbg(&adapter->dev,
			"W83L785TS-S detection failed at 0x%02x\n",
			client->addr);
		return -ENODEV;
	}

	/* Identification */
	man_id = (w83l785ts_read_value(client, W83L785TS_REG_MAN_ID1, 0) << 8)
	       + w83l785ts_read_value(client, W83L785TS_REG_MAN_ID2, 0);
	chip_id = w83l785ts_read_value(client, W83L785TS_REG_CHIP_ID, 0);

	if (man_id != 0x5CA3		/* Winbond */
	 || chip_id != 0x70) {		/* W83L785TS-S */
		dev_dbg(&adapter->dev,
			"Unsupported chip (man_id=0x%04X, chip_id=0x%02X)\n",
			man_id, chip_id);
		return -ENODEV;
	}

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

	return 0;
}

static int w83l785ts_probe(struct i2c_client *client,
			   const struct i2c_device_id *id)
{
	struct w83l785ts_data *data;
	struct device *dev = &client->dev;
	int err;

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

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

	/*
	 * Initialize the W83L785TS chip
	 * Nothing yet, assume it is already started.
	 */

	err = device_create_file(dev, &sensor_dev_attr_temp1_input.dev_attr);
	if (err)
		return err;

	err = device_create_file(dev, &sensor_dev_attr_temp1_max.dev_attr);
	if (err)
		goto exit_remove;

	/* Register sysfs hooks */
	data->hwmon_dev = hwmon_device_register(dev);
	if (IS_ERR(data->hwmon_dev)) {
		err = PTR_ERR(data->hwmon_dev);
		goto exit_remove;
	}

	return 0;

exit_remove:
	device_remove_file(dev, &sensor_dev_attr_temp1_input.dev_attr);
	device_remove_file(dev, &sensor_dev_attr_temp1_max.dev_attr);
	return err;
}

static int w83l785ts_remove(struct i2c_client *client)
{
	struct w83l785ts_data *data = i2c_get_clientdata(client);

	hwmon_device_unregister(data->hwmon_dev);
	device_remove_file(&client->dev,
			   &sensor_dev_attr_temp1_input.dev_attr);
	device_remove_file(&client->dev,
			   &sensor_dev_attr_temp1_max.dev_attr);

	return 0;
}

static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval)
{
	int value, i;
	struct device *dev;
	const char *prefix;

	/*
	 * We might be called during detection, at which point the client
	 * isn't yet fully initialized, so we can't use dev_dbg on it
	 */
	if (i2c_get_clientdata(client)) {
		dev = &client->dev;
		prefix = "";
	} else {
		dev = &client->adapter->dev;
		prefix = "w83l785ts: ";
	}

	/*
	 * Frequent read errors have been reported on Asus boards, so we
	 * retry on read errors. If it still fails (unlikely), return the
	 * default value requested by the caller.
	 */
	for (i = 1; i <= MAX_RETRIES; i++) {
		value = i2c_smbus_read_byte_data(client, reg);
		if (value >= 0) {
			dev_dbg(dev, "%sRead 0x%02x from register 0x%02x.\n",
				prefix, value, reg);
			return value;
		}
		dev_dbg(dev, "%sRead failed, will retry in %d.\n", prefix, i);
		msleep(i);
	}

	dev_err(dev, "%sCouldn't read value from register 0x%02x.\n", prefix,
		reg);
	return defval;
}

static struct w83l785ts_data *w83l785ts_update_device(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct w83l785ts_data *data = i2c_get_clientdata(client);

	mutex_lock(&data->update_lock);

	if (!data->valid || time_after(jiffies, data->last_updated + HZ * 2)) {
		dev_dbg(&client->dev, "Updating w83l785ts data.\n");
		data->temp[0] = w83l785ts_read_value(client,
				W83L785TS_REG_TEMP, data->temp[0]);
		data->temp[1] = w83l785ts_read_value(client,
				W83L785TS_REG_TEMP_OVER, data->temp[1]);

		data->last_updated = jiffies;
		data->valid = 1;
	}

	mutex_unlock(&data->update_lock);

	return data;
}

module_i2c_driver(w83l785ts_driver);

MODULE_AUTHOR("Jean Delvare <[email protected]>");
MODULE_DESCRIPTION("W83L785TS-S driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
74ba9207	1	// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 LT	2	/*
	3	* w83l785ts.c - Part of lm_sensors, Linux kernel modules for hardware
	4	* monitoring
7c81c60f	5	* Copyright (C) 2003-2009 Jean Delvare <[email protected]>
1da177e4 LT	6	*
	7	* Inspired from the lm83 driver. The W83L785TS-S is a sensor chip made
	8	* by Winbond. It reports a single external temperature with a 1 deg
	9	* resolution and a 3 deg accuracy. Datasheet can be obtained from
	10	* Winbond's website at:
	11	* http://www.winbond-usa.com/products/winbond_products/pdfs/PCIC/W83L785TS-S.pdf
	12	*
	13	* Ported to Linux 2.6 by Wolfgang Ziegler <[email protected]> and Jean Delvare
7c81c60f	14	* <[email protected]>.
1da177e4 LT	15	*
	16	* Thanks to James Bolt <[email protected]> for benchmarking the read
	17	* error handling mechanism.
1da177e4 LT	18	*/
1da177e4 LT	19
1da177e4 LT	20	#include <linux/module.h>
	21	#include <linux/delay.h>
	22	#include <linux/init.h>
	23	#include <linux/slab.h>
	24	#include <linux/jiffies.h>
	25	#include <linux/i2c.h>
943b0830	26	#include <linux/hwmon.h>
709439a2	27	#include <linux/hwmon-sysfs.h>
943b0830	28	#include <linux/err.h>
9a61bf63	29	#include <linux/mutex.h>
1da177e4 LT	30
	31	/* How many retries on register read error */
	32	#define MAX_RETRIES 5
	33
	34	/*
	35	* Address to scan
	36	* Address is fully defined internally and cannot be changed.
	37	*/
	38
25e9c86d	39	static const unsigned short normal_i2c[] = { 0x2e, I2C_CLIENT_END };
1da177e4	40
1da177e4 LT	41	/*
	42	* The W83L785TS-S registers
	43	* Manufacturer ID is 0x5CA3 for Winbond.
	44	*/
	45
	46	#define W83L785TS_REG_MAN_ID1 0x4D
	47	#define W83L785TS_REG_MAN_ID2 0x4C
	48	#define W83L785TS_REG_CHIP_ID 0x4E
	49	#define W83L785TS_REG_CONFIG 0x40
	50	#define W83L785TS_REG_TYPE 0x52
	51	#define W83L785TS_REG_TEMP 0x27
	52	#define W83L785TS_REG_TEMP_OVER 0x53 /* not sure about this one */
	53
	54	/*
	55	* Conversions
	56	* The W83L785TS-S uses signed 8-bit values.
	57	*/
	58
cb929eae	59	#define TEMP_FROM_REG(val) ((val) * 1000)
1da177e4 LT	60
	61	/*
	62	* Functions declaration
	63	*/
	64
dc18a418 JD	65	static int w83l785ts_probe(struct i2c_client *client,
dc18a418 JD	66	const struct i2c_device_id *id);
310ec792	67	static int w83l785ts_detect(struct i2c_client *client,
dc18a418 JD	68	struct i2c_board_info *info);
dc18a418 JD	69	static int w83l785ts_remove(struct i2c_client *client);
1da177e4 LT	70	static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval);
	71	static struct w83l785ts_data w83l785ts_update_device(struct device dev);
	72
	73	/*
	74	* Driver data (common to all clients)
	75	*/
59965425	76
dc18a418	77	static const struct i2c_device_id w83l785ts_id[] = {
1f86df49	78	{ "w83l785ts", 0 },
dc18a418 JD	79	{ }
	80	};
	81	MODULE_DEVICE_TABLE(i2c, w83l785ts_id);
	82
1da177e4	83	static struct i2c_driver w83l785ts_driver = {
dc18a418	84	.class = I2C_CLASS_HWMON,
cdaf7934	85	.driver = {
cdaf7934 LR	86	.name = "w83l785ts",
cdaf7934 LR	87	},
dc18a418 JD	88	.probe = w83l785ts_probe,
	89	.remove = w83l785ts_remove,
	90	.id_table = w83l785ts_id,
	91	.detect = w83l785ts_detect,
c3813d6a	92	.address_list = normal_i2c,
1da177e4 LT	93	};
	94
	95	/*
	96	* Client data (each client gets its own)
	97	*/
	98
	99	struct w83l785ts_data {
1beeffe4	100	struct device *hwmon_dev;
9a61bf63	101	struct mutex update_lock;
1da177e4 LT	102	char valid; /* zero until following fields are valid */
	103	unsigned long last_updated; /* in jiffies */
	104
	105	/* registers values */
130067d7	106	s8 temp[2]; /* 0: input, 1: critical limit */
1da177e4 LT	107	};
	108
	109	/*
	110	* Sysfs stuff
	111	*/
	112
709439a2 JD	113	static ssize_t show_temp(struct device dev, struct device_attribute devattr,
709439a2 JD	114	char *buf)
1da177e4	115	{
709439a2	116	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
1da177e4	117	struct w83l785ts_data *data = w83l785ts_update_device(dev);
709439a2	118	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
1da177e4 LT	119	}
1da177e4 LT	120
709439a2 JD	121	static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
709439a2 JD	122	static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 1);
1da177e4 LT	123
	124	/*
	125	* Real code
	126	*/
	127
dc18a418	128	/* Return 0 if detection is successful, -ENODEV otherwise */
310ec792	129	static int w83l785ts_detect(struct i2c_client *client,
dc18a418	130	struct i2c_board_info *info)
1da177e4	131	{
a1fa4cdc JD	132	struct i2c_adapter *adapter = client->adapter;
	133	u16 man_id;
	134	u8 chip_id;
1da177e4 LT	135
1da177e4 LT	136	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
dc18a418	137	return -ENODEV;
1da177e4	138
a1fa4cdc JD	139	/* detection */
	140	if ((w83l785ts_read_value(client, W83L785TS_REG_CONFIG, 0) & 0x80)
	141	\|\| (w83l785ts_read_value(client, W83L785TS_REG_TYPE, 0) & 0xFC)) {
	142	dev_dbg(&adapter->dev,
	143	"W83L785TS-S detection failed at 0x%02x\n",
	144	client->addr);
	145	return -ENODEV;
1da177e4 LT	146	}
1da177e4 LT	147
a1fa4cdc JD	148	/* Identification */
	149	man_id = (w83l785ts_read_value(client, W83L785TS_REG_MAN_ID1, 0) << 8)
	150	+ w83l785ts_read_value(client, W83L785TS_REG_MAN_ID2, 0);
	151	chip_id = w83l785ts_read_value(client, W83L785TS_REG_CHIP_ID, 0);
	152
	153	if (man_id != 0x5CA3 /* Winbond */
	154	\|\| chip_id != 0x70) { /* W83L785TS-S */
	155	dev_dbg(&adapter->dev,
	156	"Unsupported chip (man_id=0x%04X, chip_id=0x%02X)\n",
	157	man_id, chip_id);
	158	return -ENODEV;
1da177e4 LT	159	}
1da177e4 LT	160
dc18a418 JD	161	strlcpy(info->type, "w83l785ts", I2C_NAME_SIZE);
	162
	163	return 0;
	164	}
	165
f187fc04	166	static int w83l785ts_probe(struct i2c_client *client,
dc18a418 JD	167	const struct i2c_device_id *id)
	168	{
	169	struct w83l785ts_data *data;
f187fc04	170	struct device *dev = &client->dev;
e2730bea	171	int err;
dc18a418	172
e2730bea GR	173	data = devm_kzalloc(dev, sizeof(struct w83l785ts_data), GFP_KERNEL);
	174	if (!data)
	175	return -ENOMEM;
dc18a418	176
f187fc04	177	i2c_set_clientdata(client, data);
9a61bf63	178	mutex_init(&data->update_lock);
1da177e4	179
1da177e4 LT	180	/*
	181	* Initialize the W83L785TS chip
	182	* Nothing yet, assume it is already started.
	183	*/
	184
f187fc04	185	err = device_create_file(dev, &sensor_dev_attr_temp1_input.dev_attr);
ccc5c306	186	if (err)
e2730bea	187	return err;
ccc5c306	188
f187fc04	189	err = device_create_file(dev, &sensor_dev_attr_temp1_max.dev_attr);
ccc5c306 RM	190	if (err)
	191	goto exit_remove;
	192
1da177e4	193	/* Register sysfs hooks */
f187fc04	194	data->hwmon_dev = hwmon_device_register(dev);
1beeffe4 TJ	195	if (IS_ERR(data->hwmon_dev)) {
1beeffe4 TJ	196	err = PTR_ERR(data->hwmon_dev);
ccc5c306	197	goto exit_remove;
943b0830 MH	198	}
943b0830 MH	199
1da177e4 LT	200	return 0;
1da177e4 LT	201
ccc5c306	202	exit_remove:
f187fc04 GR	203	device_remove_file(dev, &sensor_dev_attr_temp1_input.dev_attr);
f187fc04 GR	204	device_remove_file(dev, &sensor_dev_attr_temp1_max.dev_attr);
1da177e4 LT	205	return err;
	206	}
	207
dc18a418	208	static int w83l785ts_remove(struct i2c_client *client)
1da177e4	209	{
943b0830	210	struct w83l785ts_data *data = i2c_get_clientdata(client);
1da177e4	211
1beeffe4	212	hwmon_device_unregister(data->hwmon_dev);
ccc5c306 RM	213	device_remove_file(&client->dev,
	214	&sensor_dev_attr_temp1_input.dev_attr);
	215	device_remove_file(&client->dev,
	216	&sensor_dev_attr_temp1_max.dev_attr);
1da177e4	217
1da177e4 LT	218	return 0;
	219	}
	220
	221	static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval)
	222	{
	223	int value, i;
dc18a418 JD	224	struct device *dev;
	225	const char *prefix;
	226
130067d7 GR	227	/*
	228	* We might be called during detection, at which point the client
	229	* isn't yet fully initialized, so we can't use dev_dbg on it
	230	*/
dc18a418 JD	231	if (i2c_get_clientdata(client)) {
	232	dev = &client->dev;
	233	prefix = "";
	234	} else {
	235	dev = &client->adapter->dev;
	236	prefix = "w83l785ts: ";
	237	}
1da177e4	238
130067d7 GR	239	/*
130067d7 GR	240	* Frequent read errors have been reported on Asus boards, so we
1da177e4	241	* retry on read errors. If it still fails (unlikely), return the
130067d7 GR	242	* default value requested by the caller.
130067d7 GR	243	*/
1da177e4 LT	244	for (i = 1; i <= MAX_RETRIES; i++) {
	245	value = i2c_smbus_read_byte_data(client, reg);
	246	if (value >= 0) {
dc18a418 JD	247	dev_dbg(dev, "%sRead 0x%02x from register 0x%02x.\n",
dc18a418 JD	248	prefix, value, reg);
1da177e4 LT	249	return value;
1da177e4 LT	250	}
dc18a418	251	dev_dbg(dev, "%sRead failed, will retry in %d.\n", prefix, i);
1da177e4 LT	252	msleep(i);
	253	}
	254
dc18a418	255	dev_err(dev, "%sCouldn't read value from register 0x%02x.\n", prefix,
4040c415	256	reg);
1da177e4 LT	257	return defval;
	258	}
	259
	260	static struct w83l785ts_data w83l785ts_update_device(struct device dev)
	261	{
	262	struct i2c_client *client = to_i2c_client(dev);
	263	struct w83l785ts_data *data = i2c_get_clientdata(client);
	264
9a61bf63	265	mutex_lock(&data->update_lock);
1da177e4 LT	266
	267	if (!data->valid \|\| time_after(jiffies, data->last_updated + HZ * 2)) {
	268	dev_dbg(&client->dev, "Updating w83l785ts data.\n");
709439a2 JD	269	data->temp[0] = w83l785ts_read_value(client,
	270	W83L785TS_REG_TEMP, data->temp[0]);
	271	data->temp[1] = w83l785ts_read_value(client,
	272	W83L785TS_REG_TEMP_OVER, data->temp[1]);
1da177e4 LT	273
	274	data->last_updated = jiffies;
	275	data->valid = 1;
	276	}
	277
9a61bf63	278	mutex_unlock(&data->update_lock);
1da177e4 LT	279
	280	return data;
	281	}
	282
f0967eea	283	module_i2c_driver(w83l785ts_driver);
1da177e4	284
7c81c60f	285	MODULE_AUTHOR("Jean Delvare <[email protected]>");
1da177e4 LT	286	MODULE_DESCRIPTION("W83L785TS-S driver");
1da177e4 LT	287	MODULE_LICENSE("GPL");