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, |
28 | I2C_CLIENT_END }; | |
9410700b | 29 | |
05c77ab2 | 30 | enum chips { tmp421, tmp422, tmp423, tmp441, tmp442 }; |
9410700b | 31 | |
cae02339 | 32 | #define MAX_CHANNELS 4 |
9410700b | 33 | /* The TMP421 registers */ |
a63ee9d8 | 34 | #define TMP421_STATUS_REG 0x08 |
9410700b AP |
35 | #define TMP421_CONFIG_REG_1 0x09 |
36 | #define TMP421_CONVERSION_RATE_REG 0x0B | |
37 | #define TMP421_MANUFACTURER_ID_REG 0xFE | |
38 | #define TMP421_DEVICE_ID_REG 0xFF | |
39 | ||
cae02339 KA |
40 | static const u8 TMP421_TEMP_MSB[MAX_CHANNELS] = { 0x00, 0x01, 0x02, 0x03 }; |
41 | static const u8 TMP421_TEMP_LSB[MAX_CHANNELS] = { 0x10, 0x11, 0x12, 0x13 }; | |
9410700b AP |
42 | |
43 | /* Flags */ | |
44 | #define TMP421_CONFIG_SHUTDOWN 0x40 | |
45 | #define TMP421_CONFIG_RANGE 0x04 | |
46 | ||
47 | /* Manufacturer / Device ID's */ | |
48 | #define TMP421_MANUFACTURER_ID 0x55 | |
49 | #define TMP421_DEVICE_ID 0x21 | |
50 | #define TMP422_DEVICE_ID 0x22 | |
51 | #define TMP423_DEVICE_ID 0x23 | |
05c77ab2 GR |
52 | #define TMP441_DEVICE_ID 0x41 |
53 | #define TMP442_DEVICE_ID 0x42 | |
9410700b AP |
54 | |
55 | static const struct i2c_device_id tmp421_id[] = { | |
8d59582a JD |
56 | { "tmp421", 2 }, |
57 | { "tmp422", 3 }, | |
58 | { "tmp423", 4 }, | |
05c77ab2 GR |
59 | { "tmp441", 2 }, |
60 | { "tmp442", 3 }, | |
9410700b AP |
61 | { } |
62 | }; | |
63 | MODULE_DEVICE_TABLE(i2c, tmp421_id); | |
64 | ||
bd7d56a7 | 65 | static const struct of_device_id __maybe_unused tmp421_of_match[] = { |
a1253027 JMC |
66 | { |
67 | .compatible = "ti,tmp421", | |
68 | .data = (void *)2 | |
69 | }, | |
70 | { | |
71 | .compatible = "ti,tmp422", | |
72 | .data = (void *)3 | |
73 | }, | |
74 | { | |
75 | .compatible = "ti,tmp423", | |
76 | .data = (void *)4 | |
77 | }, | |
78 | { | |
79 | .compatible = "ti,tmp441", | |
80 | .data = (void *)2 | |
81 | }, | |
82 | { | |
f422449b | 83 | .compatible = "ti,tmp442", |
a1253027 JMC |
84 | .data = (void *)3 |
85 | }, | |
86 | { }, | |
87 | }; | |
88 | MODULE_DEVICE_TABLE(of, tmp421_of_match); | |
89 | ||
5e3dbeac | 90 | struct tmp421_channel { |
c1143d1b | 91 | const char *label; |
45e9bda4 | 92 | bool enabled; |
5e3dbeac KA |
93 | s16 temp; |
94 | }; | |
95 | ||
9410700b | 96 | struct tmp421_data { |
276dac80 | 97 | struct i2c_client *client; |
9410700b | 98 | struct mutex update_lock; |
cae02339 | 99 | u32 temp_config[MAX_CHANNELS + 1]; |
bb43cc45 GR |
100 | struct hwmon_channel_info temp_info; |
101 | const struct hwmon_channel_info *info[2]; | |
102 | struct hwmon_chip_info chip; | |
952a11ca | 103 | bool valid; |
9410700b | 104 | unsigned long last_updated; |
a1253027 | 105 | unsigned long channels; |
9410700b | 106 | u8 config; |
5e3dbeac | 107 | struct tmp421_channel channel[MAX_CHANNELS]; |
9410700b AP |
108 | }; |
109 | ||
724e8af8 | 110 | static int temp_from_raw(u16 reg, bool extended) |
9410700b | 111 | { |
a44908d7 JD |
112 | /* Mask out status bits */ |
113 | int temp = reg & ~0xf; | |
9410700b | 114 | |
724e8af8 PF |
115 | if (extended) |
116 | temp = temp - 64 * 256; | |
117 | else | |
118 | temp = (s16)temp; | |
9410700b | 119 | |
724e8af8 | 120 | return DIV_ROUND_CLOSEST(temp * 1000, 256); |
9410700b AP |
121 | } |
122 | ||
2938b297 | 123 | static int tmp421_update_device(struct tmp421_data *data) |
9410700b | 124 | { |
276dac80 | 125 | struct i2c_client *client = data->client; |
2938b297 | 126 | int ret = 0; |
9410700b AP |
127 | int i; |
128 | ||
129 | mutex_lock(&data->update_lock); | |
130 | ||
5ff02752 KR |
131 | if (time_after(jiffies, data->last_updated + (HZ / 2)) || |
132 | !data->valid) { | |
2938b297 PF |
133 | ret = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1); |
134 | if (ret < 0) | |
135 | goto exit; | |
136 | data->config = ret; | |
9410700b | 137 | |
8d59582a | 138 | for (i = 0; i < data->channels; i++) { |
2938b297 PF |
139 | ret = i2c_smbus_read_byte_data(client, TMP421_TEMP_MSB[i]); |
140 | if (ret < 0) | |
141 | goto exit; | |
5e3dbeac | 142 | data->channel[i].temp = ret << 8; |
2938b297 PF |
143 | |
144 | ret = i2c_smbus_read_byte_data(client, TMP421_TEMP_LSB[i]); | |
145 | if (ret < 0) | |
146 | goto exit; | |
5e3dbeac | 147 | data->channel[i].temp |= ret; |
9410700b AP |
148 | } |
149 | data->last_updated = jiffies; | |
952a11ca | 150 | data->valid = true; |
9410700b AP |
151 | } |
152 | ||
2938b297 | 153 | exit: |
9410700b AP |
154 | mutex_unlock(&data->update_lock); |
155 | ||
2938b297 | 156 | if (ret < 0) { |
952a11ca | 157 | data->valid = false; |
2938b297 PF |
158 | return ret; |
159 | } | |
160 | ||
161 | return 0; | |
9410700b AP |
162 | } |
163 | ||
bb43cc45 GR |
164 | static int tmp421_read(struct device *dev, enum hwmon_sensor_types type, |
165 | u32 attr, int channel, long *val) | |
9410700b | 166 | { |
2938b297 PF |
167 | struct tmp421_data *tmp421 = dev_get_drvdata(dev); |
168 | int ret = 0; | |
169 | ||
170 | ret = tmp421_update_device(tmp421); | |
171 | if (ret) | |
172 | return ret; | |
bb43cc45 | 173 | |
45e9bda4 KA |
174 | if (!tmp421->channel[channel].enabled) |
175 | return -ENODATA; | |
176 | ||
bb43cc45 GR |
177 | switch (attr) { |
178 | case hwmon_temp_input: | |
5e3dbeac | 179 | *val = temp_from_raw(tmp421->channel[channel].temp, |
724e8af8 | 180 | tmp421->config & TMP421_CONFIG_RANGE); |
bb43cc45 GR |
181 | return 0; |
182 | case hwmon_temp_fault: | |
183 | /* | |
540effa7 PF |
184 | * Any of OPEN or /PVLD bits indicate a hardware mulfunction |
185 | * and the conversion result may be incorrect | |
bb43cc45 | 186 | */ |
5e3dbeac | 187 | *val = !!(tmp421->channel[channel].temp & 0x03); |
bb43cc45 GR |
188 | return 0; |
189 | default: | |
190 | return -EOPNOTSUPP; | |
191 | } | |
9410700b | 192 | |
9410700b AP |
193 | } |
194 | ||
c1143d1b KA |
195 | static int tmp421_read_string(struct device *dev, enum hwmon_sensor_types type, |
196 | u32 attr, int channel, const char **str) | |
197 | { | |
198 | struct tmp421_data *data = dev_get_drvdata(dev); | |
199 | ||
200 | *str = data->channel[channel].label; | |
201 | ||
202 | return 0; | |
203 | } | |
204 | ||
bb43cc45 GR |
205 | static umode_t tmp421_is_visible(const void *data, enum hwmon_sensor_types type, |
206 | u32 attr, int channel) | |
9410700b | 207 | { |
bb43cc45 GR |
208 | switch (attr) { |
209 | case hwmon_temp_fault: | |
bb43cc45 | 210 | case hwmon_temp_input: |
b626eb22 | 211 | return 0444; |
c1143d1b KA |
212 | case hwmon_temp_label: |
213 | return 0444; | |
bb43cc45 GR |
214 | default: |
215 | return 0; | |
216 | } | |
9410700b AP |
217 | } |
218 | ||
9410700b AP |
219 | static int tmp421_init_client(struct i2c_client *client) |
220 | { | |
221 | int config, config_orig; | |
222 | ||
223 | /* Set the conversion rate to 2 Hz */ | |
224 | i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05); | |
225 | ||
226 | /* Start conversions (disable shutdown if necessary) */ | |
227 | config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1); | |
228 | if (config < 0) { | |
b55f3757 GR |
229 | dev_err(&client->dev, |
230 | "Could not read configuration register (%d)\n", config); | |
010a166a | 231 | return config; |
9410700b AP |
232 | } |
233 | ||
234 | config_orig = config; | |
235 | config &= ~TMP421_CONFIG_SHUTDOWN; | |
236 | ||
237 | if (config != config_orig) { | |
238 | dev_info(&client->dev, "Enable monitoring chip\n"); | |
239 | i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config); | |
240 | } | |
241 | ||
242 | return 0; | |
243 | } | |
244 | ||
310ec792 | 245 | static int tmp421_detect(struct i2c_client *client, |
9410700b AP |
246 | struct i2c_board_info *info) |
247 | { | |
dbe73c8f | 248 | enum chips kind; |
9410700b | 249 | struct i2c_adapter *adapter = client->adapter; |
8b9bf554 CIK |
250 | static const char * const names[] = { |
251 | "TMP421", "TMP422", "TMP423", | |
252 | "TMP441", "TMP442" | |
253 | }; | |
a63ee9d8 | 254 | int addr = client->addr; |
dbe73c8f | 255 | u8 reg; |
9410700b AP |
256 | |
257 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) | |
258 | return -ENODEV; | |
259 | ||
dbe73c8f JD |
260 | reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG); |
261 | if (reg != TMP421_MANUFACTURER_ID) | |
262 | return -ENODEV; | |
263 | ||
a63ee9d8 GR |
264 | reg = i2c_smbus_read_byte_data(client, TMP421_CONVERSION_RATE_REG); |
265 | if (reg & 0xf8) | |
266 | return -ENODEV; | |
267 | ||
268 | reg = i2c_smbus_read_byte_data(client, TMP421_STATUS_REG); | |
269 | if (reg & 0x7f) | |
270 | return -ENODEV; | |
271 | ||
dbe73c8f JD |
272 | reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG); |
273 | switch (reg) { | |
274 | case TMP421_DEVICE_ID: | |
275 | kind = tmp421; | |
276 | break; | |
277 | case TMP422_DEVICE_ID: | |
a63ee9d8 GR |
278 | if (addr == 0x2a) |
279 | return -ENODEV; | |
dbe73c8f JD |
280 | kind = tmp422; |
281 | break; | |
282 | case TMP423_DEVICE_ID: | |
a63ee9d8 GR |
283 | if (addr != 0x4c && addr != 0x4d) |
284 | return -ENODEV; | |
dbe73c8f JD |
285 | kind = tmp423; |
286 | break; | |
05c77ab2 GR |
287 | case TMP441_DEVICE_ID: |
288 | kind = tmp441; | |
289 | break; | |
290 | case TMP442_DEVICE_ID: | |
291 | if (addr != 0x4c && addr != 0x4d) | |
292 | return -ENODEV; | |
293 | kind = tmp442; | |
294 | break; | |
dbe73c8f JD |
295 | default: |
296 | return -ENODEV; | |
9410700b | 297 | } |
dbe73c8f | 298 | |
dc71afe5 | 299 | strlcpy(info->type, tmp421_id[kind].name, I2C_NAME_SIZE); |
9410700b | 300 | dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n", |
dc71afe5 | 301 | names[kind], client->addr); |
9410700b AP |
302 | |
303 | return 0; | |
304 | } | |
305 | ||
c1143d1b KA |
306 | static int tmp421_probe_child_from_dt(struct i2c_client *client, |
307 | struct device_node *child, | |
308 | struct tmp421_data *data) | |
309 | ||
310 | { | |
311 | struct device *dev = &client->dev; | |
312 | u32 i; | |
313 | int err; | |
314 | ||
315 | err = of_property_read_u32(child, "reg", &i); | |
316 | if (err) { | |
317 | dev_err(dev, "missing reg property of %pOFn\n", child); | |
318 | return err; | |
319 | } | |
320 | ||
321 | if (i >= data->channels) { | |
322 | dev_err(dev, "invalid reg %d of %pOFn\n", i, child); | |
323 | return -EINVAL; | |
324 | } | |
325 | ||
326 | of_property_read_string(child, "label", &data->channel[i].label); | |
327 | if (data->channel[i].label) | |
328 | data->temp_config[i] |= HWMON_T_LABEL; | |
329 | ||
45e9bda4 KA |
330 | data->channel[i].enabled = of_device_is_available(child); |
331 | ||
c1143d1b KA |
332 | return 0; |
333 | } | |
334 | ||
335 | static int tmp421_probe_from_dt(struct i2c_client *client, struct tmp421_data *data) | |
336 | { | |
337 | struct device *dev = &client->dev; | |
338 | const struct device_node *np = dev->of_node; | |
339 | struct device_node *child; | |
340 | int err; | |
341 | ||
342 | for_each_child_of_node(np, child) { | |
343 | err = tmp421_probe_child_from_dt(client, child, data); | |
344 | if (err) | |
345 | return err; | |
346 | } | |
347 | ||
348 | return 0; | |
349 | } | |
350 | ||
bb43cc45 GR |
351 | static const struct hwmon_ops tmp421_ops = { |
352 | .is_visible = tmp421_is_visible, | |
353 | .read = tmp421_read, | |
c1143d1b | 354 | .read_string = tmp421_read_string, |
bb43cc45 GR |
355 | }; |
356 | ||
67487038 | 357 | static int tmp421_probe(struct i2c_client *client) |
9410700b | 358 | { |
276dac80 GR |
359 | struct device *dev = &client->dev; |
360 | struct device *hwmon_dev; | |
9410700b | 361 | struct tmp421_data *data; |
bb43cc45 | 362 | int i, err; |
9410700b | 363 | |
276dac80 | 364 | data = devm_kzalloc(dev, sizeof(struct tmp421_data), GFP_KERNEL); |
9410700b AP |
365 | if (!data) |
366 | return -ENOMEM; | |
367 | ||
9410700b | 368 | mutex_init(&data->update_lock); |
a1253027 JMC |
369 | if (client->dev.of_node) |
370 | data->channels = (unsigned long) | |
371 | of_device_get_match_data(&client->dev); | |
372 | else | |
67487038 | 373 | data->channels = i2c_match_id(tmp421_id, client)->driver_data; |
276dac80 | 374 | data->client = client; |
9410700b AP |
375 | |
376 | err = tmp421_init_client(client); | |
377 | if (err) | |
f625e0fd | 378 | return err; |
9410700b | 379 | |
45e9bda4 | 380 | for (i = 0; i < data->channels; i++) { |
bb43cc45 | 381 | data->temp_config[i] = HWMON_T_INPUT | HWMON_T_FAULT; |
45e9bda4 KA |
382 | data->channel[i].enabled = true; |
383 | } | |
bb43cc45 | 384 | |
c1143d1b KA |
385 | err = tmp421_probe_from_dt(client, data); |
386 | if (err) | |
387 | return err; | |
388 | ||
bb43cc45 GR |
389 | data->chip.ops = &tmp421_ops; |
390 | data->chip.info = data->info; | |
391 | ||
392 | data->info[0] = &data->temp_info; | |
393 | ||
394 | data->temp_info.type = hwmon_temp; | |
395 | data->temp_info.config = data->temp_config; | |
396 | ||
397 | hwmon_dev = devm_hwmon_device_register_with_info(dev, client->name, | |
398 | data, | |
399 | &data->chip, | |
400 | NULL); | |
276dac80 | 401 | return PTR_ERR_OR_ZERO(hwmon_dev); |
9410700b AP |
402 | } |
403 | ||
404 | static struct i2c_driver tmp421_driver = { | |
405 | .class = I2C_CLASS_HWMON, | |
406 | .driver = { | |
407 | .name = "tmp421", | |
a1253027 | 408 | .of_match_table = of_match_ptr(tmp421_of_match), |
9410700b | 409 | }, |
67487038 | 410 | .probe_new = tmp421_probe, |
9410700b AP |
411 | .id_table = tmp421_id, |
412 | .detect = tmp421_detect, | |
c3813d6a | 413 | .address_list = normal_i2c, |
9410700b AP |
414 | }; |
415 | ||
f0967eea | 416 | module_i2c_driver(tmp421_driver); |
9410700b AP |
417 | |
418 | MODULE_AUTHOR("Andre Prendel <andre.prendel@gmx.de>"); | |
05c77ab2 | 419 | MODULE_DESCRIPTION("Texas Instruments TMP421/422/423/441/442 temperature sensor driver"); |
9410700b | 420 | MODULE_LICENSE("GPL"); |