blob: ac30431220115d9f5efff73288f4bb3baa1d5cf9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * w83l785ts.c - Part of lm_sensors, Linux kernel modules for hardware
3 * monitoring
Jean Delvare7c81c602014-01-29 20:40:08 +01004 * Copyright (C) 2003-2009 Jean Delvare <jdelvare@suse.de>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
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
Jean Delvare7c81c602014-01-29 20:40:08 +010013 * <jdelvare@suse.de>.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 *
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#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>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040039#include <linux/hwmon.h>
Jean Delvare709439a2005-09-25 16:41:18 +020040#include <linux/hwmon-sysfs.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040041#include <linux/err.h>
Ingo Molnar9a61bf62006-01-18 23:19:26 +010042#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
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
Mark M. Hoffman25e9c862008-02-17 22:28:03 -050052static const unsigned short normal_i2c[] = { 0x2e, I2C_CLIENT_END };
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * 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
Jean Delvarecb929ea2005-09-25 16:45:03 +020072#define TEMP_FROM_REG(val) ((val) * 1000)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74/*
75 * Functions declaration
76 */
77
Jean Delvaredc18a412008-07-16 19:30:18 +020078static int w83l785ts_probe(struct i2c_client *client,
79 const struct i2c_device_id *id);
Jean Delvare310ec792009-12-14 21:17:23 +010080static int w83l785ts_detect(struct i2c_client *client,
Jean Delvaredc18a412008-07-16 19:30:18 +020081 struct i2c_board_info *info);
82static int w83l785ts_remove(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083static 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 */
Frans Meulenbroeks59965422012-01-08 19:34:16 +010089
Jean Delvaredc18a412008-07-16 19:30:18 +020090static const struct i2c_device_id w83l785ts_id[] = {
Jean Delvare1f86df42009-12-14 21:17:26 +010091 { "w83l785ts", 0 },
Jean Delvaredc18a412008-07-16 19:30:18 +020092 { }
93};
94MODULE_DEVICE_TABLE(i2c, w83l785ts_id);
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096static struct i2c_driver w83l785ts_driver = {
Jean Delvaredc18a412008-07-16 19:30:18 +020097 .class = I2C_CLASS_HWMON,
Laurent Riffardcdaf7932005-11-26 20:37:41 +010098 .driver = {
Laurent Riffardcdaf7932005-11-26 20:37:41 +010099 .name = "w83l785ts",
100 },
Jean Delvaredc18a412008-07-16 19:30:18 +0200101 .probe = w83l785ts_probe,
102 .remove = w83l785ts_remove,
103 .id_table = w83l785ts_id,
104 .detect = w83l785ts_detect,
Jean Delvarec3813d62009-12-14 21:17:25 +0100105 .address_list = normal_i2c,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106};
107
108/*
109 * Client data (each client gets its own)
110 */
111
112struct w83l785ts_data {
Tony Jones1beeffe2007-08-20 13:46:20 -0700113 struct device *hwmon_dev;
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100114 struct mutex update_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 char valid; /* zero until following fields are valid */
116 unsigned long last_updated; /* in jiffies */
117
118 /* registers values */
Guenter Roeck130067d2012-01-19 11:02:28 -0800119 s8 temp[2]; /* 0: input, 1: critical limit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120};
121
122/*
123 * Sysfs stuff
124 */
125
Jean Delvare709439a2005-09-25 16:41:18 +0200126static ssize_t show_temp(struct device *dev, struct device_attribute *devattr,
127 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128{
Jean Delvare709439a2005-09-25 16:41:18 +0200129 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 struct w83l785ts_data *data = w83l785ts_update_device(dev);
Jean Delvare709439a2005-09-25 16:41:18 +0200131 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132}
133
Jean Delvare709439a2005-09-25 16:41:18 +0200134static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
135static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137/*
138 * Real code
139 */
140
Jean Delvaredc18a412008-07-16 19:30:18 +0200141/* Return 0 if detection is successful, -ENODEV otherwise */
Jean Delvare310ec792009-12-14 21:17:23 +0100142static int w83l785ts_detect(struct i2c_client *client,
Jean Delvaredc18a412008-07-16 19:30:18 +0200143 struct i2c_board_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
Jean Delvarea1fa4cdc2009-12-09 20:35:56 +0100145 struct i2c_adapter *adapter = client->adapter;
146 u16 man_id;
147 u8 chip_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
Jean Delvaredc18a412008-07-16 19:30:18 +0200150 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Jean Delvarea1fa4cdc2009-12-09 20:35:56 +0100152 /* detection */
153 if ((w83l785ts_read_value(client, W83L785TS_REG_CONFIG, 0) & 0x80)
154 || (w83l785ts_read_value(client, W83L785TS_REG_TYPE, 0) & 0xFC)) {
155 dev_dbg(&adapter->dev,
156 "W83L785TS-S detection failed at 0x%02x\n",
157 client->addr);
158 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 }
160
Jean Delvarea1fa4cdc2009-12-09 20:35:56 +0100161 /* Identification */
162 man_id = (w83l785ts_read_value(client, W83L785TS_REG_MAN_ID1, 0) << 8)
163 + w83l785ts_read_value(client, W83L785TS_REG_MAN_ID2, 0);
164 chip_id = w83l785ts_read_value(client, W83L785TS_REG_CHIP_ID, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Jean Delvarea1fa4cdc2009-12-09 20:35:56 +0100166 if (man_id != 0x5CA3 /* Winbond */
167 || chip_id != 0x70) { /* W83L785TS-S */
168 dev_dbg(&adapter->dev,
169 "Unsupported chip (man_id=0x%04X, chip_id=0x%02X)\n",
170 man_id, chip_id);
171 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 }
173
Jean Delvaredc18a412008-07-16 19:30:18 +0200174 strlcpy(info->type, "w83l785ts", I2C_NAME_SIZE);
175
176 return 0;
177}
178
Guenter Roeckf187fc02012-06-02 11:48:01 -0700179static int w83l785ts_probe(struct i2c_client *client,
Jean Delvaredc18a412008-07-16 19:30:18 +0200180 const struct i2c_device_id *id)
181{
182 struct w83l785ts_data *data;
Guenter Roeckf187fc02012-06-02 11:48:01 -0700183 struct device *dev = &client->dev;
Guenter Roecke2730be2012-06-18 08:26:05 -0700184 int err;
Jean Delvaredc18a412008-07-16 19:30:18 +0200185
Guenter Roecke2730be2012-06-18 08:26:05 -0700186 data = devm_kzalloc(dev, sizeof(struct w83l785ts_data), GFP_KERNEL);
187 if (!data)
188 return -ENOMEM;
Jean Delvaredc18a412008-07-16 19:30:18 +0200189
Guenter Roeckf187fc02012-06-02 11:48:01 -0700190 i2c_set_clientdata(client, data);
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100191 mutex_init(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 /*
194 * Initialize the W83L785TS chip
195 * Nothing yet, assume it is already started.
196 */
197
Guenter Roeckf187fc02012-06-02 11:48:01 -0700198 err = device_create_file(dev, &sensor_dev_attr_temp1_input.dev_attr);
Rudolf Marekccc5c302006-09-24 21:23:26 +0200199 if (err)
Guenter Roecke2730be2012-06-18 08:26:05 -0700200 return err;
Rudolf Marekccc5c302006-09-24 21:23:26 +0200201
Guenter Roeckf187fc02012-06-02 11:48:01 -0700202 err = device_create_file(dev, &sensor_dev_attr_temp1_max.dev_attr);
Rudolf Marekccc5c302006-09-24 21:23:26 +0200203 if (err)
204 goto exit_remove;
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 /* Register sysfs hooks */
Guenter Roeckf187fc02012-06-02 11:48:01 -0700207 data->hwmon_dev = hwmon_device_register(dev);
Tony Jones1beeffe2007-08-20 13:46:20 -0700208 if (IS_ERR(data->hwmon_dev)) {
209 err = PTR_ERR(data->hwmon_dev);
Rudolf Marekccc5c302006-09-24 21:23:26 +0200210 goto exit_remove;
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400211 }
212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 return 0;
214
Rudolf Marekccc5c302006-09-24 21:23:26 +0200215exit_remove:
Guenter Roeckf187fc02012-06-02 11:48:01 -0700216 device_remove_file(dev, &sensor_dev_attr_temp1_input.dev_attr);
217 device_remove_file(dev, &sensor_dev_attr_temp1_max.dev_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 return err;
219}
220
Jean Delvaredc18a412008-07-16 19:30:18 +0200221static int w83l785ts_remove(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222{
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400223 struct w83l785ts_data *data = i2c_get_clientdata(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Tony Jones1beeffe2007-08-20 13:46:20 -0700225 hwmon_device_unregister(data->hwmon_dev);
Rudolf Marekccc5c302006-09-24 21:23:26 +0200226 device_remove_file(&client->dev,
227 &sensor_dev_attr_temp1_input.dev_attr);
228 device_remove_file(&client->dev,
229 &sensor_dev_attr_temp1_max.dev_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 return 0;
232}
233
234static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval)
235{
236 int value, i;
Jean Delvaredc18a412008-07-16 19:30:18 +0200237 struct device *dev;
238 const char *prefix;
239
Guenter Roeck130067d2012-01-19 11:02:28 -0800240 /*
241 * We might be called during detection, at which point the client
242 * isn't yet fully initialized, so we can't use dev_dbg on it
243 */
Jean Delvaredc18a412008-07-16 19:30:18 +0200244 if (i2c_get_clientdata(client)) {
245 dev = &client->dev;
246 prefix = "";
247 } else {
248 dev = &client->adapter->dev;
249 prefix = "w83l785ts: ";
250 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Guenter Roeck130067d2012-01-19 11:02:28 -0800252 /*
253 * Frequent read errors have been reported on Asus boards, so we
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 * retry on read errors. If it still fails (unlikely), return the
Guenter Roeck130067d2012-01-19 11:02:28 -0800255 * default value requested by the caller.
256 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 for (i = 1; i <= MAX_RETRIES; i++) {
258 value = i2c_smbus_read_byte_data(client, reg);
259 if (value >= 0) {
Jean Delvaredc18a412008-07-16 19:30:18 +0200260 dev_dbg(dev, "%sRead 0x%02x from register 0x%02x.\n",
261 prefix, value, reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 return value;
263 }
Jean Delvaredc18a412008-07-16 19:30:18 +0200264 dev_dbg(dev, "%sRead failed, will retry in %d.\n", prefix, i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 msleep(i);
266 }
267
Jean Delvaredc18a412008-07-16 19:30:18 +0200268 dev_err(dev, "%sCouldn't read value from register 0x%02x.\n", prefix,
Jean Delvare4040c412008-02-12 11:17:26 +0100269 reg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 return defval;
271}
272
273static struct w83l785ts_data *w83l785ts_update_device(struct device *dev)
274{
275 struct i2c_client *client = to_i2c_client(dev);
276 struct w83l785ts_data *data = i2c_get_clientdata(client);
277
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100278 mutex_lock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280 if (!data->valid || time_after(jiffies, data->last_updated + HZ * 2)) {
281 dev_dbg(&client->dev, "Updating w83l785ts data.\n");
Jean Delvare709439a2005-09-25 16:41:18 +0200282 data->temp[0] = w83l785ts_read_value(client,
283 W83L785TS_REG_TEMP, data->temp[0]);
284 data->temp[1] = w83l785ts_read_value(client,
285 W83L785TS_REG_TEMP_OVER, data->temp[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287 data->last_updated = jiffies;
288 data->valid = 1;
289 }
290
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100291 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293 return data;
294}
295
Axel Linf0967ee2012-01-20 15:38:18 +0800296module_i2c_driver(w83l785ts_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Jean Delvare7c81c602014-01-29 20:40:08 +0100298MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299MODULE_DESCRIPTION("W83L785TS-S driver");
300MODULE_LICENSE("GPL");