[mirror_ubuntu-jammy-kernel.git] / drivers / hwmon / tmp421.c

// SPDX-License-Identifier: GPL-2.0-or-later
/* tmp421.c
 *
 * Copyright (C) 2009 Andre Prendel <andre.prendel@gmx.de>
 * Preliminary support by:
 * Melvin Rook, Raymond Ng
 */

/*
 * Driver for the Texas Instruments TMP421 SMBus temperature sensor IC.
 * Supported models: TMP421, TMP422, TMP423, TMP441, TMP442
 */

#include <linux/module.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>
#include <linux/of_device.h>
#include <linux/sysfs.h>

/* Addresses to scan */
static const unsigned short normal_i2c[] = { 0x2a, 0x4c, 0x4d, 0x4e, 0x4f,
					     I2C_CLIENT_END };

enum chips { tmp421, tmp422, tmp423, tmp441, tmp442 };

/* The TMP421 registers */
#define TMP421_STATUS_REG			0x08
#define TMP421_CONFIG_REG_1			0x09
#define TMP421_CONVERSION_RATE_REG		0x0B
#define TMP421_MANUFACTURER_ID_REG		0xFE
#define TMP421_DEVICE_ID_REG			0xFF

static const u8 TMP421_TEMP_MSB[4]		= { 0x00, 0x01, 0x02, 0x03 };
static const u8 TMP421_TEMP_LSB[4]		= { 0x10, 0x11, 0x12, 0x13 };

/* Flags */
#define TMP421_CONFIG_SHUTDOWN			0x40
#define TMP421_CONFIG_RANGE			0x04

/* Manufacturer / Device ID's */
#define TMP421_MANUFACTURER_ID			0x55
#define TMP421_DEVICE_ID			0x21
#define TMP422_DEVICE_ID			0x22
#define TMP423_DEVICE_ID			0x23
#define TMP441_DEVICE_ID			0x41
#define TMP442_DEVICE_ID			0x42

static const struct i2c_device_id tmp421_id[] = {
	{ "tmp421", 2 },
	{ "tmp422", 3 },
	{ "tmp423", 4 },
	{ "tmp441", 2 },
	{ "tmp442", 3 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, tmp421_id);

static const struct of_device_id __maybe_unused tmp421_of_match[] = {
	{
		.compatible = "ti,tmp421",
		.data = (void *)2
	},
	{
		.compatible = "ti,tmp422",
		.data = (void *)3
	},
	{
		.compatible = "ti,tmp423",
		.data = (void *)4
	},
	{
		.compatible = "ti,tmp441",
		.data = (void *)2
	},
	{
		.compatible = "ti,tmp442",
		.data = (void *)3
	},
	{ },
};
MODULE_DEVICE_TABLE(of, tmp421_of_match);

struct tmp421_data {
	struct i2c_client *client;
	struct mutex update_lock;
	u32 temp_config[5];
	struct hwmon_channel_info temp_info;
	const struct hwmon_channel_info *info[2];
	struct hwmon_chip_info chip;
	char valid;
	unsigned long last_updated;
	unsigned long channels;
	u8 config;
	s16 temp[4];
};

static int temp_from_s16(s16 reg)
{
	/* Mask out status bits */
	int temp = reg & ~0xf;

	return (temp * 1000 + 128) / 256;
}

static int temp_from_u16(u16 reg)
{
	/* Mask out status bits */
	int temp = reg & ~0xf;

	/* Add offset for extended temperature range. */
	temp -= 64 * 256;

	return (temp * 1000 + 128) / 256;
}

static struct tmp421_data *tmp421_update_device(struct device *dev)
{
	struct tmp421_data *data = dev_get_drvdata(dev);
	struct i2c_client *client = data->client;
	int i;

	mutex_lock(&data->update_lock);

	if (time_after(jiffies, data->last_updated + (HZ / 2)) ||
	    !data->valid) {
		data->config = i2c_smbus_read_byte_data(client,
			TMP421_CONFIG_REG_1);

		for (i = 0; i < data->channels; i++) {
			data->temp[i] = i2c_smbus_read_byte_data(client,
				TMP421_TEMP_MSB[i]) << 8;
			data->temp[i] |= i2c_smbus_read_byte_data(client,
				TMP421_TEMP_LSB[i]);
		}
		data->last_updated = jiffies;
		data->valid = 1;
	}

	mutex_unlock(&data->update_lock);

	return data;
}

static int tmp421_read(struct device *dev, enum hwmon_sensor_types type,
		       u32 attr, int channel, long *val)
{
	struct tmp421_data *tmp421 = tmp421_update_device(dev);

	switch (attr) {
	case hwmon_temp_input:
		if (tmp421->config & TMP421_CONFIG_RANGE)
			*val = temp_from_u16(tmp421->temp[channel]);
		else
			*val = temp_from_s16(tmp421->temp[channel]);
		return 0;
	case hwmon_temp_fault:
		/*
		 * The OPEN bit signals a fault. This is bit 0 of the temperature
		 * register (low byte).
		 */
		*val = tmp421->temp[channel] & 0x01;
		return 0;
	default:
		return -EOPNOTSUPP;
	}

}

static umode_t tmp421_is_visible(const void *data, enum hwmon_sensor_types type,
				 u32 attr, int channel)
{
	switch (attr) {
	case hwmon_temp_fault:
		if (channel == 0)
			return 0;
		return 0444;
	case hwmon_temp_input:
		return 0444;
	default:
		return 0;
	}
}

static int tmp421_init_client(struct i2c_client *client)
{
	int config, config_orig;

	/* Set the conversion rate to 2 Hz */
	i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05);

	/* Start conversions (disable shutdown if necessary) */
	config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
	if (config < 0) {
		dev_err(&client->dev,
			"Could not read configuration register (%d)\n", config);
		return config;
	}

	config_orig = config;
	config &= ~TMP421_CONFIG_SHUTDOWN;

	if (config != config_orig) {
		dev_info(&client->dev, "Enable monitoring chip\n");
		i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config);
	}

	return 0;
}

static int tmp421_detect(struct i2c_client *client,
			 struct i2c_board_info *info)
{
	enum chips kind;
	struct i2c_adapter *adapter = client->adapter;
	static const char * const names[] = {
		"TMP421", "TMP422", "TMP423",
		"TMP441", "TMP442"
	};
	int addr = client->addr;
	u8 reg;

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

	reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG);
	if (reg != TMP421_MANUFACTURER_ID)
		return -ENODEV;

	reg = i2c_smbus_read_byte_data(client, TMP421_CONVERSION_RATE_REG);
	if (reg & 0xf8)
		return -ENODEV;

	reg = i2c_smbus_read_byte_data(client, TMP421_STATUS_REG);
	if (reg & 0x7f)
		return -ENODEV;

	reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG);
	switch (reg) {
	case TMP421_DEVICE_ID:
		kind = tmp421;
		break;
	case TMP422_DEVICE_ID:
		if (addr == 0x2a)
			return -ENODEV;
		kind = tmp422;
		break;
	case TMP423_DEVICE_ID:
		if (addr != 0x4c && addr != 0x4d)
			return -ENODEV;
		kind = tmp423;
		break;
	case TMP441_DEVICE_ID:
		kind = tmp441;
		break;
	case TMP442_DEVICE_ID:
		if (addr != 0x4c && addr != 0x4d)
			return -ENODEV;
		kind = tmp442;
		break;
	default:
		return -ENODEV;
	}

	strlcpy(info->type, tmp421_id[kind].name, I2C_NAME_SIZE);
	dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n",
		 names[kind], client->addr);

	return 0;
}

static const struct hwmon_ops tmp421_ops = {
	.is_visible = tmp421_is_visible,
	.read = tmp421_read,
};

static int tmp421_probe(struct i2c_client *client)
{
	struct device *dev = &client->dev;
	struct device *hwmon_dev;
	struct tmp421_data *data;
	int i, err;

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

	mutex_init(&data->update_lock);
	if (client->dev.of_node)
		data->channels = (unsigned long)
			of_device_get_match_data(&client->dev);
	else
		data->channels = i2c_match_id(tmp421_id, client)->driver_data;
	data->client = client;

	err = tmp421_init_client(client);
	if (err)
		return err;

	for (i = 0; i < data->channels; i++)
		data->temp_config[i] = HWMON_T_INPUT | HWMON_T_FAULT;

	data->chip.ops = &tmp421_ops;
	data->chip.info = data->info;

	data->info[0] = &data->temp_info;

	data->temp_info.type = hwmon_temp;
	data->temp_info.config = data->temp_config;

	hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name,
							 data,
							 &data->chip,
							 NULL);
	return PTR_ERR_OR_ZERO(hwmon_dev);
}

static struct i2c_driver tmp421_driver = {
	.class = I2C_CLASS_HWMON,
	.driver = {
		.name	= "tmp421",
		.of_match_table = of_match_ptr(tmp421_of_match),
	},
	.probe_new = tmp421_probe,
	.id_table = tmp421_id,
	.detect = tmp421_detect,
	.address_list = normal_i2c,
};

module_i2c_driver(tmp421_driver);

MODULE_AUTHOR("Andre Prendel <andre.prendel@gmx.de>");
MODULE_DESCRIPTION("Texas Instruments TMP421/422/423/441/442 temperature sensor driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
c942fddf	1	// SPDX-License-Identifier: GPL-2.0-or-later
9410700b AP	2	/* tmp421.c
	3	*
	4	* Copyright (C) 2009 Andre Prendel <andre.prendel@gmx.de>
	5	* Preliminary support by:
	6	* Melvin Rook, Raymond Ng
9410700b AP	7	*/
	8
	9	/*
	10	* Driver for the Texas Instruments TMP421 SMBus temperature sensor IC.
05c77ab2	11	* Supported models: TMP421, TMP422, TMP423, TMP441, TMP442
9410700b AP	12	*/
	13
	14	#include <linux/module.h>
	15	#include <linux/init.h>
	16	#include <linux/slab.h>
	17	#include <linux/jiffies.h>
	18	#include <linux/i2c.h>
	19	#include <linux/hwmon.h>
	20	#include <linux/hwmon-sysfs.h>
	21	#include <linux/err.h>
	22	#include <linux/mutex.h>
a1253027	23	#include <linux/of_device.h>
9410700b AP	24	#include <linux/sysfs.h>
	25
	26	/* Addresses to scan */
918ee91c JD	27	static const unsigned short normal_i2c[] = { 0x2a, 0x4c, 0x4d, 0x4e, 0x4f,
918ee91c JD	28	I2C_CLIENT_END };
9410700b	29
05c77ab2	30	enum chips { tmp421, tmp422, tmp423, tmp441, tmp442 };
9410700b AP	31
9410700b AP	32	/* The TMP421 registers */
a63ee9d8	33	#define TMP421_STATUS_REG 0x08
9410700b AP	34	#define TMP421_CONFIG_REG_1 0x09
	35	#define TMP421_CONVERSION_RATE_REG 0x0B
	36	#define TMP421_MANUFACTURER_ID_REG 0xFE
	37	#define TMP421_DEVICE_ID_REG 0xFF
	38
	39	static const u8 TMP421_TEMP_MSB[4] = { 0x00, 0x01, 0x02, 0x03 };
	40	static const u8 TMP421_TEMP_LSB[4] = { 0x10, 0x11, 0x12, 0x13 };
	41
	42	/* Flags */
	43	#define TMP421_CONFIG_SHUTDOWN 0x40
	44	#define TMP421_CONFIG_RANGE 0x04
	45
	46	/* Manufacturer / Device ID's */
	47	#define TMP421_MANUFACTURER_ID 0x55
	48	#define TMP421_DEVICE_ID 0x21
	49	#define TMP422_DEVICE_ID 0x22
	50	#define TMP423_DEVICE_ID 0x23
05c77ab2 GR	51	#define TMP441_DEVICE_ID 0x41
05c77ab2 GR	52	#define TMP442_DEVICE_ID 0x42
9410700b AP	53
9410700b AP	54	static const struct i2c_device_id tmp421_id[] = {
8d59582a JD	55	{ "tmp421", 2 },
	56	{ "tmp422", 3 },
	57	{ "tmp423", 4 },
05c77ab2 GR	58	{ "tmp441", 2 },
05c77ab2 GR	59	{ "tmp442", 3 },
9410700b AP	60	{ }
	61	};
	62	MODULE_DEVICE_TABLE(i2c, tmp421_id);
	63
bd7d56a7	64	static const struct of_device_id __maybe_unused tmp421_of_match[] = {
a1253027 JMC	65	{
	66	.compatible = "ti,tmp421",
	67	.data = (void *)2
	68	},
	69	{
	70	.compatible = "ti,tmp422",
	71	.data = (void *)3
	72	},
	73	{
	74	.compatible = "ti,tmp423",
	75	.data = (void *)4
	76	},
	77	{
	78	.compatible = "ti,tmp441",
	79	.data = (void *)2
	80	},
	81	{
f422449b	82	.compatible = "ti,tmp442",
a1253027 JMC	83	.data = (void *)3
	84	},
	85	{ },
	86	};
	87	MODULE_DEVICE_TABLE(of, tmp421_of_match);
	88
9410700b	89	struct tmp421_data {
276dac80	90	struct i2c_client *client;
9410700b	91	struct mutex update_lock;
bb43cc45 GR	92	u32 temp_config[5];
	93	struct hwmon_channel_info temp_info;
	94	const struct hwmon_channel_info *info[2];
	95	struct hwmon_chip_info chip;
9410700b AP	96	char valid;
9410700b AP	97	unsigned long last_updated;
a1253027	98	unsigned long channels;
9410700b AP	99	u8 config;
	100	s16 temp[4];
	101	};
	102
	103	static int temp_from_s16(s16 reg)
	104	{
a44908d7 JD	105	/* Mask out status bits */
a44908d7 JD	106	int temp = reg & ~0xf;
9410700b AP	107
	108	return (temp * 1000 + 128) / 256;
	109	}
	110
	111	static int temp_from_u16(u16 reg)
	112	{
a44908d7 JD	113	/* Mask out status bits */
a44908d7 JD	114	int temp = reg & ~0xf;
9410700b AP	115
	116	/* Add offset for extended temperature range. */
	117	temp -= 64 * 256;
	118
	119	return (temp * 1000 + 128) / 256;
	120	}
	121
	122	static struct tmp421_data tmp421_update_device(struct device dev)
	123	{
276dac80 GR	124	struct tmp421_data *data = dev_get_drvdata(dev);
276dac80 GR	125	struct i2c_client *client = data->client;
9410700b AP	126	int i;
	127
	128	mutex_lock(&data->update_lock);
	129
5ff02752 KR	130	if (time_after(jiffies, data->last_updated + (HZ / 2)) \|\|
5ff02752 KR	131	!data->valid) {
9410700b AP	132	data->config = i2c_smbus_read_byte_data(client,
	133	TMP421_CONFIG_REG_1);
	134
8d59582a	135	for (i = 0; i < data->channels; i++) {
9410700b AP	136	data->temp[i] = i2c_smbus_read_byte_data(client,
	137	TMP421_TEMP_MSB[i]) << 8;
	138	data->temp[i] \|= i2c_smbus_read_byte_data(client,
	139	TMP421_TEMP_LSB[i]);
	140	}
	141	data->last_updated = jiffies;
	142	data->valid = 1;
	143	}
	144
	145	mutex_unlock(&data->update_lock);
	146
	147	return data;
	148	}
	149
bb43cc45 GR	150	static int tmp421_read(struct device *dev, enum hwmon_sensor_types type,
bb43cc45 GR	151	u32 attr, int channel, long *val)
9410700b	152	{
bb43cc45 GR	153	struct tmp421_data *tmp421 = tmp421_update_device(dev);
	154
	155	switch (attr) {
	156	case hwmon_temp_input:
	157	if (tmp421->config & TMP421_CONFIG_RANGE)
	158	*val = temp_from_u16(tmp421->temp[channel]);
	159	else
	160	*val = temp_from_s16(tmp421->temp[channel]);
	161	return 0;
	162	case hwmon_temp_fault:
	163	/*
	164	* The OPEN bit signals a fault. This is bit 0 of the temperature
	165	* register (low byte).
	166	*/
	167	*val = tmp421->temp[channel] & 0x01;
	168	return 0;
	169	default:
	170	return -EOPNOTSUPP;
	171	}
9410700b	172
9410700b AP	173	}
9410700b AP	174
bb43cc45 GR	175	static umode_t tmp421_is_visible(const void *data, enum hwmon_sensor_types type,
bb43cc45 GR	176	u32 attr, int channel)
9410700b	177	{
bb43cc45 GR	178	switch (attr) {
	179	case hwmon_temp_fault:
	180	if (channel == 0)
	181	return 0;
b626eb22	182	return 0444;
bb43cc45	183	case hwmon_temp_input:
b626eb22	184	return 0444;
bb43cc45 GR	185	default:
	186	return 0;
	187	}
9410700b AP	188	}
9410700b AP	189
9410700b AP	190	static int tmp421_init_client(struct i2c_client *client)
	191	{
	192	int config, config_orig;
	193
	194	/* Set the conversion rate to 2 Hz */
	195	i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05);
	196
	197	/* Start conversions (disable shutdown if necessary) */
	198	config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
	199	if (config < 0) {
b55f3757 GR	200	dev_err(&client->dev,
b55f3757 GR	201	"Could not read configuration register (%d)\n", config);
010a166a	202	return config;
9410700b AP	203	}
	204
	205	config_orig = config;
	206	config &= ~TMP421_CONFIG_SHUTDOWN;
	207
	208	if (config != config_orig) {
	209	dev_info(&client->dev, "Enable monitoring chip\n");
	210	i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config);
	211	}
	212
	213	return 0;
	214	}
	215
310ec792	216	static int tmp421_detect(struct i2c_client *client,
9410700b AP	217	struct i2c_board_info *info)
9410700b AP	218	{
dbe73c8f	219	enum chips kind;
9410700b	220	struct i2c_adapter *adapter = client->adapter;
8b9bf554 CIK	221	static const char * const names[] = {
	222	"TMP421", "TMP422", "TMP423",
	223	"TMP441", "TMP442"
	224	};
a63ee9d8	225	int addr = client->addr;
dbe73c8f	226	u8 reg;
9410700b AP	227
	228	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
	229	return -ENODEV;
	230
dbe73c8f JD	231	reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG);
	232	if (reg != TMP421_MANUFACTURER_ID)
	233	return -ENODEV;
	234
a63ee9d8 GR	235	reg = i2c_smbus_read_byte_data(client, TMP421_CONVERSION_RATE_REG);
	236	if (reg & 0xf8)
	237	return -ENODEV;
	238
	239	reg = i2c_smbus_read_byte_data(client, TMP421_STATUS_REG);
	240	if (reg & 0x7f)
	241	return -ENODEV;
	242
dbe73c8f JD	243	reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG);
	244	switch (reg) {
	245	case TMP421_DEVICE_ID:
	246	kind = tmp421;
	247	break;
	248	case TMP422_DEVICE_ID:
a63ee9d8 GR	249	if (addr == 0x2a)
a63ee9d8 GR	250	return -ENODEV;
dbe73c8f JD	251	kind = tmp422;
	252	break;
	253	case TMP423_DEVICE_ID:
a63ee9d8 GR	254	if (addr != 0x4c && addr != 0x4d)
a63ee9d8 GR	255	return -ENODEV;
dbe73c8f JD	256	kind = tmp423;
dbe73c8f JD	257	break;
05c77ab2 GR	258	case TMP441_DEVICE_ID:
	259	kind = tmp441;
	260	break;
	261	case TMP442_DEVICE_ID:
	262	if (addr != 0x4c && addr != 0x4d)
	263	return -ENODEV;
	264	kind = tmp442;
	265	break;
dbe73c8f JD	266	default:
dbe73c8f JD	267	return -ENODEV;
9410700b	268	}
dbe73c8f	269
dc71afe5	270	strlcpy(info->type, tmp421_id[kind].name, I2C_NAME_SIZE);
9410700b	271	dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n",
dc71afe5	272	names[kind], client->addr);
9410700b AP	273
	274	return 0;
	275	}
	276
bb43cc45 GR	277	static const struct hwmon_ops tmp421_ops = {
	278	.is_visible = tmp421_is_visible,
	279	.read = tmp421_read,
	280	};
	281
67487038	282	static int tmp421_probe(struct i2c_client *client)
9410700b	283	{
276dac80 GR	284	struct device *dev = &client->dev;
276dac80 GR	285	struct device *hwmon_dev;
9410700b	286	struct tmp421_data *data;
bb43cc45	287	int i, err;
9410700b	288
276dac80	289	data = devm_kzalloc(dev, sizeof(struct tmp421_data), GFP_KERNEL);
9410700b AP	290	if (!data)
	291	return -ENOMEM;
	292
9410700b	293	mutex_init(&data->update_lock);
a1253027 JMC	294	if (client->dev.of_node)
	295	data->channels = (unsigned long)
	296	of_device_get_match_data(&client->dev);
	297	else
67487038	298	data->channels = i2c_match_id(tmp421_id, client)->driver_data;
276dac80	299	data->client = client;
9410700b AP	300
	301	err = tmp421_init_client(client);
	302	if (err)
f625e0fd	303	return err;
9410700b	304
bb43cc45 GR	305	for (i = 0; i < data->channels; i++)
	306	data->temp_config[i] = HWMON_T_INPUT \| HWMON_T_FAULT;
	307
	308	data->chip.ops = &tmp421_ops;
	309	data->chip.info = data->info;
	310
	311	data->info[0] = &data->temp_info;
	312
	313	data->temp_info.type = hwmon_temp;
	314	data->temp_info.config = data->temp_config;
	315
	316	hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name,
	317	data,
	318	&data->chip,
	319	NULL);
276dac80	320	return PTR_ERR_OR_ZERO(hwmon_dev);
9410700b AP	321	}
	322
	323	static struct i2c_driver tmp421_driver = {
	324	.class = I2C_CLASS_HWMON,
	325	.driver = {
	326	.name = "tmp421",
a1253027	327	.of_match_table = of_match_ptr(tmp421_of_match),
9410700b	328	},
67487038	329	.probe_new = tmp421_probe,
9410700b AP	330	.id_table = tmp421_id,
9410700b AP	331	.detect = tmp421_detect,
c3813d6a	332	.address_list = normal_i2c,
9410700b AP	333	};
9410700b AP	334
f0967eea	335	module_i2c_driver(tmp421_driver);
9410700b AP	336
9410700b AP	337	MODULE_AUTHOR("Andre Prendel <andre.prendel@gmx.de>");
05c77ab2	338	MODULE_DESCRIPTION("Texas Instruments TMP421/422/423/441/442 temperature sensor driver");
9410700b	339	MODULE_LICENSE("GPL");