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