Loading...
1/* tmp421.c
2 *
3 * Copyright (C) 2009 Andre Prendel <andre.prendel@gmx.de>
4 * Preliminary support by:
5 * Melvin Rook, Raymond Ng
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22/*
23 * Driver for the Texas Instruments TMP421 SMBus temperature sensor IC.
24 * Supported models: TMP421, TMP422, TMP423
25 */
26
27#include <linux/module.h>
28#include <linux/init.h>
29#include <linux/slab.h>
30#include <linux/jiffies.h>
31#include <linux/i2c.h>
32#include <linux/hwmon.h>
33#include <linux/hwmon-sysfs.h>
34#include <linux/err.h>
35#include <linux/mutex.h>
36#include <linux/sysfs.h>
37
38/* Addresses to scan */
39static const unsigned short normal_i2c[] = { 0x2a, 0x4c, 0x4d, 0x4e, 0x4f,
40 I2C_CLIENT_END };
41
42enum chips { tmp421, tmp422, tmp423 };
43
44/* The TMP421 registers */
45#define TMP421_CONFIG_REG_1 0x09
46#define TMP421_CONVERSION_RATE_REG 0x0B
47#define TMP421_MANUFACTURER_ID_REG 0xFE
48#define TMP421_DEVICE_ID_REG 0xFF
49
50static const u8 TMP421_TEMP_MSB[4] = { 0x00, 0x01, 0x02, 0x03 };
51static const u8 TMP421_TEMP_LSB[4] = { 0x10, 0x11, 0x12, 0x13 };
52
53/* Flags */
54#define TMP421_CONFIG_SHUTDOWN 0x40
55#define TMP421_CONFIG_RANGE 0x04
56
57/* Manufacturer / Device ID's */
58#define TMP421_MANUFACTURER_ID 0x55
59#define TMP421_DEVICE_ID 0x21
60#define TMP422_DEVICE_ID 0x22
61#define TMP423_DEVICE_ID 0x23
62
63static const struct i2c_device_id tmp421_id[] = {
64 { "tmp421", 2 },
65 { "tmp422", 3 },
66 { "tmp423", 4 },
67 { }
68};
69MODULE_DEVICE_TABLE(i2c, tmp421_id);
70
71struct tmp421_data {
72 struct device *hwmon_dev;
73 struct mutex update_lock;
74 char valid;
75 unsigned long last_updated;
76 int channels;
77 u8 config;
78 s16 temp[4];
79};
80
81static int temp_from_s16(s16 reg)
82{
83 /* Mask out status bits */
84 int temp = reg & ~0xf;
85
86 return (temp * 1000 + 128) / 256;
87}
88
89static int temp_from_u16(u16 reg)
90{
91 /* Mask out status bits */
92 int temp = reg & ~0xf;
93
94 /* Add offset for extended temperature range. */
95 temp -= 64 * 256;
96
97 return (temp * 1000 + 128) / 256;
98}
99
100static struct tmp421_data *tmp421_update_device(struct device *dev)
101{
102 struct i2c_client *client = to_i2c_client(dev);
103 struct tmp421_data *data = i2c_get_clientdata(client);
104 int i;
105
106 mutex_lock(&data->update_lock);
107
108 if (time_after(jiffies, data->last_updated + 2 * HZ) || !data->valid) {
109 data->config = i2c_smbus_read_byte_data(client,
110 TMP421_CONFIG_REG_1);
111
112 for (i = 0; i < data->channels; i++) {
113 data->temp[i] = i2c_smbus_read_byte_data(client,
114 TMP421_TEMP_MSB[i]) << 8;
115 data->temp[i] |= i2c_smbus_read_byte_data(client,
116 TMP421_TEMP_LSB[i]);
117 }
118 data->last_updated = jiffies;
119 data->valid = 1;
120 }
121
122 mutex_unlock(&data->update_lock);
123
124 return data;
125}
126
127static ssize_t show_temp_value(struct device *dev,
128 struct device_attribute *devattr, char *buf)
129{
130 int index = to_sensor_dev_attr(devattr)->index;
131 struct tmp421_data *data = tmp421_update_device(dev);
132 int temp;
133
134 mutex_lock(&data->update_lock);
135 if (data->config & TMP421_CONFIG_RANGE)
136 temp = temp_from_u16(data->temp[index]);
137 else
138 temp = temp_from_s16(data->temp[index]);
139 mutex_unlock(&data->update_lock);
140
141 return sprintf(buf, "%d\n", temp);
142}
143
144static ssize_t show_fault(struct device *dev,
145 struct device_attribute *devattr, char *buf)
146{
147 int index = to_sensor_dev_attr(devattr)->index;
148 struct tmp421_data *data = tmp421_update_device(dev);
149
150 /*
151 * The OPEN bit signals a fault. This is bit 0 of the temperature
152 * register (low byte).
153 */
154 if (data->temp[index] & 0x01)
155 return sprintf(buf, "1\n");
156 else
157 return sprintf(buf, "0\n");
158}
159
160static mode_t tmp421_is_visible(struct kobject *kobj, struct attribute *a,
161 int n)
162{
163 struct device *dev = container_of(kobj, struct device, kobj);
164 struct tmp421_data *data = dev_get_drvdata(dev);
165 struct device_attribute *devattr;
166 unsigned int index;
167
168 devattr = container_of(a, struct device_attribute, attr);
169 index = to_sensor_dev_attr(devattr)->index;
170
171 if (index < data->channels)
172 return a->mode;
173
174 return 0;
175}
176
177static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_value, NULL, 0);
178static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp_value, NULL, 1);
179static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_fault, NULL, 1);
180static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp_value, NULL, 2);
181static SENSOR_DEVICE_ATTR(temp3_fault, S_IRUGO, show_fault, NULL, 2);
182static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp_value, NULL, 3);
183static SENSOR_DEVICE_ATTR(temp4_fault, S_IRUGO, show_fault, NULL, 3);
184
185static struct attribute *tmp421_attr[] = {
186 &sensor_dev_attr_temp1_input.dev_attr.attr,
187 &sensor_dev_attr_temp2_input.dev_attr.attr,
188 &sensor_dev_attr_temp2_fault.dev_attr.attr,
189 &sensor_dev_attr_temp3_input.dev_attr.attr,
190 &sensor_dev_attr_temp3_fault.dev_attr.attr,
191 &sensor_dev_attr_temp4_input.dev_attr.attr,
192 &sensor_dev_attr_temp4_fault.dev_attr.attr,
193 NULL
194};
195
196static const struct attribute_group tmp421_group = {
197 .attrs = tmp421_attr,
198 .is_visible = tmp421_is_visible,
199};
200
201static int tmp421_init_client(struct i2c_client *client)
202{
203 int config, config_orig;
204
205 /* Set the conversion rate to 2 Hz */
206 i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05);
207
208 /* Start conversions (disable shutdown if necessary) */
209 config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
210 if (config < 0) {
211 dev_err(&client->dev, "Could not read configuration"
212 " register (%d)\n", config);
213 return -ENODEV;
214 }
215
216 config_orig = config;
217 config &= ~TMP421_CONFIG_SHUTDOWN;
218
219 if (config != config_orig) {
220 dev_info(&client->dev, "Enable monitoring chip\n");
221 i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config);
222 }
223
224 return 0;
225}
226
227static int tmp421_detect(struct i2c_client *client,
228 struct i2c_board_info *info)
229{
230 enum chips kind;
231 struct i2c_adapter *adapter = client->adapter;
232 const char *names[] = { "TMP421", "TMP422", "TMP423" };
233 u8 reg;
234
235 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
236 return -ENODEV;
237
238 reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG);
239 if (reg != TMP421_MANUFACTURER_ID)
240 return -ENODEV;
241
242 reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG);
243 switch (reg) {
244 case TMP421_DEVICE_ID:
245 kind = tmp421;
246 break;
247 case TMP422_DEVICE_ID:
248 kind = tmp422;
249 break;
250 case TMP423_DEVICE_ID:
251 kind = tmp423;
252 break;
253 default:
254 return -ENODEV;
255 }
256
257 strlcpy(info->type, tmp421_id[kind].name, I2C_NAME_SIZE);
258 dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n",
259 names[kind], client->addr);
260
261 return 0;
262}
263
264static int tmp421_probe(struct i2c_client *client,
265 const struct i2c_device_id *id)
266{
267 struct tmp421_data *data;
268 int err;
269
270 data = kzalloc(sizeof(struct tmp421_data), GFP_KERNEL);
271 if (!data)
272 return -ENOMEM;
273
274 i2c_set_clientdata(client, data);
275 mutex_init(&data->update_lock);
276 data->channels = id->driver_data;
277
278 err = tmp421_init_client(client);
279 if (err)
280 goto exit_free;
281
282 err = sysfs_create_group(&client->dev.kobj, &tmp421_group);
283 if (err)
284 goto exit_free;
285
286 data->hwmon_dev = hwmon_device_register(&client->dev);
287 if (IS_ERR(data->hwmon_dev)) {
288 err = PTR_ERR(data->hwmon_dev);
289 data->hwmon_dev = NULL;
290 goto exit_remove;
291 }
292 return 0;
293
294exit_remove:
295 sysfs_remove_group(&client->dev.kobj, &tmp421_group);
296
297exit_free:
298 kfree(data);
299
300 return err;
301}
302
303static int tmp421_remove(struct i2c_client *client)
304{
305 struct tmp421_data *data = i2c_get_clientdata(client);
306
307 hwmon_device_unregister(data->hwmon_dev);
308 sysfs_remove_group(&client->dev.kobj, &tmp421_group);
309
310 kfree(data);
311
312 return 0;
313}
314
315static struct i2c_driver tmp421_driver = {
316 .class = I2C_CLASS_HWMON,
317 .driver = {
318 .name = "tmp421",
319 },
320 .probe = tmp421_probe,
321 .remove = tmp421_remove,
322 .id_table = tmp421_id,
323 .detect = tmp421_detect,
324 .address_list = normal_i2c,
325};
326
327static int __init tmp421_init(void)
328{
329 return i2c_add_driver(&tmp421_driver);
330}
331
332static void __exit tmp421_exit(void)
333{
334 i2c_del_driver(&tmp421_driver);
335}
336
337MODULE_AUTHOR("Andre Prendel <andre.prendel@gmx.de>");
338MODULE_DESCRIPTION("Texas Instruments TMP421/422/423 temperature sensor"
339 " driver");
340MODULE_LICENSE("GPL");
341
342module_init(tmp421_init);
343module_exit(tmp421_exit);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/* tmp421.c
3 *
4 * Copyright (C) 2009 Andre Prendel <andre.prendel@gmx.de>
5 * Preliminary support by:
6 * Melvin Rook, Raymond Ng
7 */
8
9/*
10 * Driver for the Texas Instruments TMP421 SMBus temperature sensor IC.
11 * Supported models: TMP421, TMP422, TMP423, TMP441, TMP442
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>
23#include <linux/of_device.h>
24#include <linux/sysfs.h>
25
26/* Addresses to scan */
27static const unsigned short normal_i2c[] = { 0x2a, 0x4c, 0x4d, 0x4e, 0x4f,
28 I2C_CLIENT_END };
29
30enum chips { tmp421, tmp422, tmp423, tmp441, tmp442 };
31
32/* The TMP421 registers */
33#define TMP421_STATUS_REG 0x08
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
39static const u8 TMP421_TEMP_MSB[4] = { 0x00, 0x01, 0x02, 0x03 };
40static 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
51#define TMP441_DEVICE_ID 0x41
52#define TMP442_DEVICE_ID 0x42
53
54static const struct i2c_device_id tmp421_id[] = {
55 { "tmp421", 2 },
56 { "tmp422", 3 },
57 { "tmp423", 4 },
58 { "tmp441", 2 },
59 { "tmp442", 3 },
60 { }
61};
62MODULE_DEVICE_TABLE(i2c, tmp421_id);
63
64static const struct of_device_id __maybe_unused tmp421_of_match[] = {
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 {
82 .compatible = "ti,tmp442",
83 .data = (void *)3
84 },
85 { },
86};
87MODULE_DEVICE_TABLE(of, tmp421_of_match);
88
89struct tmp421_data {
90 struct i2c_client *client;
91 struct mutex update_lock;
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;
96 char valid;
97 unsigned long last_updated;
98 unsigned long channels;
99 u8 config;
100 s16 temp[4];
101};
102
103static int temp_from_raw(u16 reg, bool extended)
104{
105 /* Mask out status bits */
106 int temp = reg & ~0xf;
107
108 if (extended)
109 temp = temp - 64 * 256;
110 else
111 temp = (s16)temp;
112
113 return DIV_ROUND_CLOSEST(temp * 1000, 256);
114}
115
116static int tmp421_update_device(struct tmp421_data *data)
117{
118 struct i2c_client *client = data->client;
119 int ret = 0;
120 int i;
121
122 mutex_lock(&data->update_lock);
123
124 if (time_after(jiffies, data->last_updated + (HZ / 2)) ||
125 !data->valid) {
126 ret = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
127 if (ret < 0)
128 goto exit;
129 data->config = ret;
130
131 for (i = 0; i < data->channels; i++) {
132 ret = i2c_smbus_read_byte_data(client, TMP421_TEMP_MSB[i]);
133 if (ret < 0)
134 goto exit;
135 data->temp[i] = ret << 8;
136
137 ret = i2c_smbus_read_byte_data(client, TMP421_TEMP_LSB[i]);
138 if (ret < 0)
139 goto exit;
140 data->temp[i] |= ret;
141 }
142 data->last_updated = jiffies;
143 data->valid = 1;
144 }
145
146exit:
147 mutex_unlock(&data->update_lock);
148
149 if (ret < 0) {
150 data->valid = 0;
151 return ret;
152 }
153
154 return 0;
155}
156
157static int tmp421_read(struct device *dev, enum hwmon_sensor_types type,
158 u32 attr, int channel, long *val)
159{
160 struct tmp421_data *tmp421 = dev_get_drvdata(dev);
161 int ret = 0;
162
163 ret = tmp421_update_device(tmp421);
164 if (ret)
165 return ret;
166
167 switch (attr) {
168 case hwmon_temp_input:
169 *val = temp_from_raw(tmp421->temp[channel],
170 tmp421->config & TMP421_CONFIG_RANGE);
171 return 0;
172 case hwmon_temp_fault:
173 /*
174 * Any of OPEN or /PVLD bits indicate a hardware mulfunction
175 * and the conversion result may be incorrect
176 */
177 *val = !!(tmp421->temp[channel] & 0x03);
178 return 0;
179 default:
180 return -EOPNOTSUPP;
181 }
182
183}
184
185static umode_t tmp421_is_visible(const void *data, enum hwmon_sensor_types type,
186 u32 attr, int channel)
187{
188 switch (attr) {
189 case hwmon_temp_fault:
190 case hwmon_temp_input:
191 return 0444;
192 default:
193 return 0;
194 }
195}
196
197static int tmp421_init_client(struct i2c_client *client)
198{
199 int config, config_orig;
200
201 /* Set the conversion rate to 2 Hz */
202 i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05);
203
204 /* Start conversions (disable shutdown if necessary) */
205 config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
206 if (config < 0) {
207 dev_err(&client->dev,
208 "Could not read configuration register (%d)\n", config);
209 return config;
210 }
211
212 config_orig = config;
213 config &= ~TMP421_CONFIG_SHUTDOWN;
214
215 if (config != config_orig) {
216 dev_info(&client->dev, "Enable monitoring chip\n");
217 i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config);
218 }
219
220 return 0;
221}
222
223static int tmp421_detect(struct i2c_client *client,
224 struct i2c_board_info *info)
225{
226 enum chips kind;
227 struct i2c_adapter *adapter = client->adapter;
228 static const char * const names[] = {
229 "TMP421", "TMP422", "TMP423",
230 "TMP441", "TMP442"
231 };
232 int addr = client->addr;
233 u8 reg;
234
235 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
236 return -ENODEV;
237
238 reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG);
239 if (reg != TMP421_MANUFACTURER_ID)
240 return -ENODEV;
241
242 reg = i2c_smbus_read_byte_data(client, TMP421_CONVERSION_RATE_REG);
243 if (reg & 0xf8)
244 return -ENODEV;
245
246 reg = i2c_smbus_read_byte_data(client, TMP421_STATUS_REG);
247 if (reg & 0x7f)
248 return -ENODEV;
249
250 reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG);
251 switch (reg) {
252 case TMP421_DEVICE_ID:
253 kind = tmp421;
254 break;
255 case TMP422_DEVICE_ID:
256 if (addr == 0x2a)
257 return -ENODEV;
258 kind = tmp422;
259 break;
260 case TMP423_DEVICE_ID:
261 if (addr != 0x4c && addr != 0x4d)
262 return -ENODEV;
263 kind = tmp423;
264 break;
265 case TMP441_DEVICE_ID:
266 kind = tmp441;
267 break;
268 case TMP442_DEVICE_ID:
269 if (addr != 0x4c && addr != 0x4d)
270 return -ENODEV;
271 kind = tmp442;
272 break;
273 default:
274 return -ENODEV;
275 }
276
277 strlcpy(info->type, tmp421_id[kind].name, I2C_NAME_SIZE);
278 dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n",
279 names[kind], client->addr);
280
281 return 0;
282}
283
284static const struct hwmon_ops tmp421_ops = {
285 .is_visible = tmp421_is_visible,
286 .read = tmp421_read,
287};
288
289static int tmp421_probe(struct i2c_client *client)
290{
291 struct device *dev = &client->dev;
292 struct device *hwmon_dev;
293 struct tmp421_data *data;
294 int i, err;
295
296 data = devm_kzalloc(dev, sizeof(struct tmp421_data), GFP_KERNEL);
297 if (!data)
298 return -ENOMEM;
299
300 mutex_init(&data->update_lock);
301 if (client->dev.of_node)
302 data->channels = (unsigned long)
303 of_device_get_match_data(&client->dev);
304 else
305 data->channels = i2c_match_id(tmp421_id, client)->driver_data;
306 data->client = client;
307
308 err = tmp421_init_client(client);
309 if (err)
310 return err;
311
312 for (i = 0; i < data->channels; i++)
313 data->temp_config[i] = HWMON_T_INPUT | HWMON_T_FAULT;
314
315 data->chip.ops = &tmp421_ops;
316 data->chip.info = data->info;
317
318 data->info[0] = &data->temp_info;
319
320 data->temp_info.type = hwmon_temp;
321 data->temp_info.config = data->temp_config;
322
323 hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name,
324 data,
325 &data->chip,
326 NULL);
327 return PTR_ERR_OR_ZERO(hwmon_dev);
328}
329
330static struct i2c_driver tmp421_driver = {
331 .class = I2C_CLASS_HWMON,
332 .driver = {
333 .name = "tmp421",
334 .of_match_table = of_match_ptr(tmp421_of_match),
335 },
336 .probe_new = tmp421_probe,
337 .id_table = tmp421_id,
338 .detect = tmp421_detect,
339 .address_list = normal_i2c,
340};
341
342module_i2c_driver(tmp421_driver);
343
344MODULE_AUTHOR("Andre Prendel <andre.prendel@gmx.de>");
345MODULE_DESCRIPTION("Texas Instruments TMP421/422/423/441/442 temperature sensor driver");
346MODULE_LICENSE("GPL");