i2c: Drop the kind parameter from detect callbacks
[linux-2.6-block.git] / drivers / hwmon / w83l785ts.c
CommitLineData
1da177e4
LT
1/*
2 * w83l785ts.c - Part of lm_sensors, Linux kernel modules for hardware
3 * monitoring
a1fa4cdc 4 * Copyright (C) 2003-2009 Jean Delvare <khali@linux-fr.org>
1da177e4
LT
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
1da177e4
LT
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>
943b0830 39#include <linux/hwmon.h>
709439a2 40#include <linux/hwmon-sysfs.h>
943b0830 41#include <linux/err.h>
9a61bf63 42#include <linux/mutex.h>
1da177e4
LT
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
25e9c86d 52static const unsigned short normal_i2c[] = { 0x2e, I2C_CLIENT_END };
1da177e4
LT
53
54/*
55 * Insmod parameters
56 */
57
f4b50261 58I2C_CLIENT_INSMOD_1(w83l785ts);
1da177e4
LT
59
60/*
61 * The W83L785TS-S registers
62 * Manufacturer ID is 0x5CA3 for Winbond.
63 */
64
65#define W83L785TS_REG_MAN_ID1 0x4D
66#define W83L785TS_REG_MAN_ID2 0x4C
67#define W83L785TS_REG_CHIP_ID 0x4E
68#define W83L785TS_REG_CONFIG 0x40
69#define W83L785TS_REG_TYPE 0x52
70#define W83L785TS_REG_TEMP 0x27
71#define W83L785TS_REG_TEMP_OVER 0x53 /* not sure about this one */
72
73/*
74 * Conversions
75 * The W83L785TS-S uses signed 8-bit values.
76 */
77
cb929eae 78#define TEMP_FROM_REG(val) ((val) * 1000)
1da177e4
LT
79
80/*
81 * Functions declaration
82 */
83
dc18a418
JD
84static int w83l785ts_probe(struct i2c_client *client,
85 const struct i2c_device_id *id);
310ec792 86static int w83l785ts_detect(struct i2c_client *client,
dc18a418
JD
87 struct i2c_board_info *info);
88static int w83l785ts_remove(struct i2c_client *client);
1da177e4
LT
89static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval);
90static struct w83l785ts_data *w83l785ts_update_device(struct device *dev);
91
92/*
93 * Driver data (common to all clients)
94 */
95
dc18a418
JD
96static const struct i2c_device_id w83l785ts_id[] = {
97 { "w83l785ts", w83l785ts },
98 { }
99};
100MODULE_DEVICE_TABLE(i2c, w83l785ts_id);
101
1da177e4 102static struct i2c_driver w83l785ts_driver = {
dc18a418 103 .class = I2C_CLASS_HWMON,
cdaf7934 104 .driver = {
cdaf7934
LR
105 .name = "w83l785ts",
106 },
dc18a418
JD
107 .probe = w83l785ts_probe,
108 .remove = w83l785ts_remove,
109 .id_table = w83l785ts_id,
110 .detect = w83l785ts_detect,
111 .address_data = &addr_data,
1da177e4
LT
112};
113
114/*
115 * Client data (each client gets its own)
116 */
117
118struct w83l785ts_data {
1beeffe4 119 struct device *hwmon_dev;
9a61bf63 120 struct mutex update_lock;
1da177e4
LT
121 char valid; /* zero until following fields are valid */
122 unsigned long last_updated; /* in jiffies */
123
124 /* registers values */
cb929eae 125 s8 temp[2]; /* 0: input
709439a2 126 1: critical limit */
1da177e4
LT
127};
128
129/*
130 * Sysfs stuff
131 */
132
709439a2
JD
133static ssize_t show_temp(struct device *dev, struct device_attribute *devattr,
134 char *buf)
1da177e4 135{
709439a2 136 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
1da177e4 137 struct w83l785ts_data *data = w83l785ts_update_device(dev);
709439a2 138 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
1da177e4
LT
139}
140
709439a2
JD
141static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
142static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 1);
1da177e4
LT
143
144/*
145 * Real code
146 */
147
dc18a418 148/* Return 0 if detection is successful, -ENODEV otherwise */
310ec792 149static int w83l785ts_detect(struct i2c_client *client,
dc18a418 150 struct i2c_board_info *info)
1da177e4 151{
a1fa4cdc
JD
152 struct i2c_adapter *adapter = client->adapter;
153 u16 man_id;
154 u8 chip_id;
1da177e4
LT
155
156 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
dc18a418 157 return -ENODEV;
1da177e4 158
a1fa4cdc
JD
159 /* detection */
160 if ((w83l785ts_read_value(client, W83L785TS_REG_CONFIG, 0) & 0x80)
161 || (w83l785ts_read_value(client, W83L785TS_REG_TYPE, 0) & 0xFC)) {
162 dev_dbg(&adapter->dev,
163 "W83L785TS-S detection failed at 0x%02x\n",
164 client->addr);
165 return -ENODEV;
1da177e4
LT
166 }
167
a1fa4cdc
JD
168 /* Identification */
169 man_id = (w83l785ts_read_value(client, W83L785TS_REG_MAN_ID1, 0) << 8)
170 + w83l785ts_read_value(client, W83L785TS_REG_MAN_ID2, 0);
171 chip_id = w83l785ts_read_value(client, W83L785TS_REG_CHIP_ID, 0);
172
173 if (man_id != 0x5CA3 /* Winbond */
174 || chip_id != 0x70) { /* W83L785TS-S */
175 dev_dbg(&adapter->dev,
176 "Unsupported chip (man_id=0x%04X, chip_id=0x%02X)\n",
177 man_id, chip_id);
178 return -ENODEV;
1da177e4
LT
179 }
180
dc18a418
JD
181 strlcpy(info->type, "w83l785ts", I2C_NAME_SIZE);
182
183 return 0;
184}
185
186static int w83l785ts_probe(struct i2c_client *new_client,
187 const struct i2c_device_id *id)
188{
189 struct w83l785ts_data *data;
190 int err = 0;
191
192 data = kzalloc(sizeof(struct w83l785ts_data), GFP_KERNEL);
193 if (!data) {
194 err = -ENOMEM;
195 goto exit;
196 }
197
198 i2c_set_clientdata(new_client, data);
1da177e4 199 data->valid = 0;
9a61bf63 200 mutex_init(&data->update_lock);
1da177e4
LT
201
202 /* Default values in case the first read fails (unlikely). */
709439a2 203 data->temp[1] = data->temp[0] = 0;
1da177e4 204
1da177e4
LT
205 /*
206 * Initialize the W83L785TS chip
207 * Nothing yet, assume it is already started.
208 */
209
ccc5c306
RM
210 err = device_create_file(&new_client->dev,
211 &sensor_dev_attr_temp1_input.dev_attr);
212 if (err)
213 goto exit_remove;
214
215 err = device_create_file(&new_client->dev,
216 &sensor_dev_attr_temp1_max.dev_attr);
217 if (err)
218 goto exit_remove;
219
1da177e4 220 /* Register sysfs hooks */
1beeffe4
TJ
221 data->hwmon_dev = hwmon_device_register(&new_client->dev);
222 if (IS_ERR(data->hwmon_dev)) {
223 err = PTR_ERR(data->hwmon_dev);
ccc5c306 224 goto exit_remove;
943b0830
MH
225 }
226
1da177e4
LT
227 return 0;
228
ccc5c306
RM
229exit_remove:
230 device_remove_file(&new_client->dev,
231 &sensor_dev_attr_temp1_input.dev_attr);
232 device_remove_file(&new_client->dev,
233 &sensor_dev_attr_temp1_max.dev_attr);
1da177e4
LT
234 kfree(data);
235exit:
236 return err;
237}
238
dc18a418 239static int w83l785ts_remove(struct i2c_client *client)
1da177e4 240{
943b0830 241 struct w83l785ts_data *data = i2c_get_clientdata(client);
1da177e4 242
1beeffe4 243 hwmon_device_unregister(data->hwmon_dev);
ccc5c306
RM
244 device_remove_file(&client->dev,
245 &sensor_dev_attr_temp1_input.dev_attr);
246 device_remove_file(&client->dev,
247 &sensor_dev_attr_temp1_max.dev_attr);
1da177e4 248
943b0830 249 kfree(data);
1da177e4
LT
250 return 0;
251}
252
253static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval)
254{
255 int value, i;
dc18a418
JD
256 struct device *dev;
257 const char *prefix;
258
259 /* We might be called during detection, at which point the client
260 isn't yet fully initialized, so we can't use dev_dbg on it */
261 if (i2c_get_clientdata(client)) {
262 dev = &client->dev;
263 prefix = "";
264 } else {
265 dev = &client->adapter->dev;
266 prefix = "w83l785ts: ";
267 }
1da177e4
LT
268
269 /* Frequent read errors have been reported on Asus boards, so we
270 * retry on read errors. If it still fails (unlikely), return the
271 * default value requested by the caller. */
272 for (i = 1; i <= MAX_RETRIES; i++) {
273 value = i2c_smbus_read_byte_data(client, reg);
274 if (value >= 0) {
dc18a418
JD
275 dev_dbg(dev, "%sRead 0x%02x from register 0x%02x.\n",
276 prefix, value, reg);
1da177e4
LT
277 return value;
278 }
dc18a418 279 dev_dbg(dev, "%sRead failed, will retry in %d.\n", prefix, i);
1da177e4
LT
280 msleep(i);
281 }
282
dc18a418 283 dev_err(dev, "%sCouldn't read value from register 0x%02x.\n", prefix,
4040c415 284 reg);
1da177e4
LT
285 return defval;
286}
287
288static struct w83l785ts_data *w83l785ts_update_device(struct device *dev)
289{
290 struct i2c_client *client = to_i2c_client(dev);
291 struct w83l785ts_data *data = i2c_get_clientdata(client);
292
9a61bf63 293 mutex_lock(&data->update_lock);
1da177e4
LT
294
295 if (!data->valid || time_after(jiffies, data->last_updated + HZ * 2)) {
296 dev_dbg(&client->dev, "Updating w83l785ts data.\n");
709439a2
JD
297 data->temp[0] = w83l785ts_read_value(client,
298 W83L785TS_REG_TEMP, data->temp[0]);
299 data->temp[1] = w83l785ts_read_value(client,
300 W83L785TS_REG_TEMP_OVER, data->temp[1]);
1da177e4
LT
301
302 data->last_updated = jiffies;
303 data->valid = 1;
304 }
305
9a61bf63 306 mutex_unlock(&data->update_lock);
1da177e4
LT
307
308 return data;
309}
310
311static int __init sensors_w83l785ts_init(void)
312{
313 return i2c_add_driver(&w83l785ts_driver);
314}
315
316static void __exit sensors_w83l785ts_exit(void)
317{
318 i2c_del_driver(&w83l785ts_driver);
319}
320
321MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
322MODULE_DESCRIPTION("W83L785TS-S driver");
323MODULE_LICENSE("GPL");
324
325module_init(sensors_w83l785ts_init);
326module_exit(sensors_w83l785ts_exit);