Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * w83l785ts.c - Part of lm_sensors, Linux kernel modules for hardware | |
3 | * monitoring | |
4 | * Copyright (C) 2003-2004 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 | ||
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> |
1da177e4 LT |
42 | |
43 | /* How many retries on register read error */ | |
44 | #define MAX_RETRIES 5 | |
45 | ||
46 | /* | |
47 | * Address to scan | |
48 | * Address is fully defined internally and cannot be changed. | |
49 | */ | |
50 | ||
51 | static unsigned short normal_i2c[] = { 0x2e, I2C_CLIENT_END }; | |
1da177e4 LT |
52 | |
53 | /* | |
54 | * Insmod parameters | |
55 | */ | |
56 | ||
f4b50261 | 57 | I2C_CLIENT_INSMOD_1(w83l785ts); |
1da177e4 LT |
58 | |
59 | /* | |
60 | * The W83L785TS-S registers | |
61 | * Manufacturer ID is 0x5CA3 for Winbond. | |
62 | */ | |
63 | ||
64 | #define W83L785TS_REG_MAN_ID1 0x4D | |
65 | #define W83L785TS_REG_MAN_ID2 0x4C | |
66 | #define W83L785TS_REG_CHIP_ID 0x4E | |
67 | #define W83L785TS_REG_CONFIG 0x40 | |
68 | #define W83L785TS_REG_TYPE 0x52 | |
69 | #define W83L785TS_REG_TEMP 0x27 | |
70 | #define W83L785TS_REG_TEMP_OVER 0x53 /* not sure about this one */ | |
71 | ||
72 | /* | |
73 | * Conversions | |
74 | * The W83L785TS-S uses signed 8-bit values. | |
75 | */ | |
76 | ||
77 | #define TEMP_FROM_REG(val) ((val & 0x80 ? val-0x100 : val) * 1000) | |
78 | ||
79 | /* | |
80 | * Functions declaration | |
81 | */ | |
82 | ||
83 | static int w83l785ts_attach_adapter(struct i2c_adapter *adapter); | |
84 | static int w83l785ts_detect(struct i2c_adapter *adapter, int address, | |
85 | int kind); | |
86 | static int w83l785ts_detach_client(struct i2c_client *client); | |
87 | static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval); | |
88 | static struct w83l785ts_data *w83l785ts_update_device(struct device *dev); | |
89 | ||
90 | /* | |
91 | * Driver data (common to all clients) | |
92 | */ | |
93 | ||
94 | static struct i2c_driver w83l785ts_driver = { | |
95 | .owner = THIS_MODULE, | |
96 | .name = "w83l785ts", | |
97 | .id = I2C_DRIVERID_W83L785TS, | |
98 | .flags = I2C_DF_NOTIFY, | |
99 | .attach_adapter = w83l785ts_attach_adapter, | |
100 | .detach_client = w83l785ts_detach_client, | |
101 | }; | |
102 | ||
103 | /* | |
104 | * Client data (each client gets its own) | |
105 | */ | |
106 | ||
107 | struct w83l785ts_data { | |
108 | struct i2c_client client; | |
943b0830 | 109 | struct class_device *class_dev; |
1da177e4 LT |
110 | struct semaphore update_lock; |
111 | char valid; /* zero until following fields are valid */ | |
112 | unsigned long last_updated; /* in jiffies */ | |
113 | ||
114 | /* registers values */ | |
709439a2 JD |
115 | u8 temp[2]; /* 0: input |
116 | 1: critical limit */ | |
1da177e4 LT |
117 | }; |
118 | ||
119 | /* | |
120 | * Sysfs stuff | |
121 | */ | |
122 | ||
709439a2 JD |
123 | static ssize_t show_temp(struct device *dev, struct device_attribute *devattr, |
124 | char *buf) | |
1da177e4 | 125 | { |
709439a2 | 126 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); |
1da177e4 | 127 | struct w83l785ts_data *data = w83l785ts_update_device(dev); |
709439a2 | 128 | return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index])); |
1da177e4 LT |
129 | } |
130 | ||
709439a2 JD |
131 | static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0); |
132 | static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 1); | |
1da177e4 LT |
133 | |
134 | /* | |
135 | * Real code | |
136 | */ | |
137 | ||
138 | static int w83l785ts_attach_adapter(struct i2c_adapter *adapter) | |
139 | { | |
140 | if (!(adapter->class & I2C_CLASS_HWMON)) | |
141 | return 0; | |
2ed2dc3c | 142 | return i2c_probe(adapter, &addr_data, w83l785ts_detect); |
1da177e4 LT |
143 | } |
144 | ||
145 | /* | |
146 | * The following function does more than just detection. If detection | |
147 | * succeeds, it also registers the new chip. | |
148 | */ | |
149 | static int w83l785ts_detect(struct i2c_adapter *adapter, int address, int kind) | |
150 | { | |
151 | struct i2c_client *new_client; | |
152 | struct w83l785ts_data *data; | |
153 | int err = 0; | |
154 | ||
155 | ||
156 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) | |
157 | goto exit; | |
158 | ||
159 | if (!(data = kmalloc(sizeof(struct w83l785ts_data), GFP_KERNEL))) { | |
160 | err = -ENOMEM; | |
161 | goto exit; | |
162 | } | |
163 | memset(data, 0, sizeof(struct w83l785ts_data)); | |
164 | ||
165 | ||
166 | /* The common I2C client data is placed right before the | |
167 | * W83L785TS-specific data. */ | |
168 | new_client = &data->client; | |
169 | i2c_set_clientdata(new_client, data); | |
170 | new_client->addr = address; | |
171 | new_client->adapter = adapter; | |
172 | new_client->driver = &w83l785ts_driver; | |
173 | new_client->flags = 0; | |
174 | ||
175 | /* | |
176 | * Now we do the remaining detection. A negative kind means that | |
177 | * the driver was loaded with no force parameter (default), so we | |
178 | * must both detect and identify the chip (actually there is only | |
179 | * one possible kind of chip for now, W83L785TS-S). A zero kind means | |
180 | * that the driver was loaded with the force parameter, the detection | |
181 | * step shall be skipped. A positive kind means that the driver | |
182 | * was loaded with the force parameter and a given kind of chip is | |
183 | * requested, so both the detection and the identification steps | |
184 | * are skipped. | |
185 | */ | |
186 | if (kind < 0) { /* detection */ | |
187 | if (((w83l785ts_read_value(new_client, | |
188 | W83L785TS_REG_CONFIG, 0) & 0x80) != 0x00) | |
189 | || ((w83l785ts_read_value(new_client, | |
190 | W83L785TS_REG_TYPE, 0) & 0xFC) != 0x00)) { | |
191 | dev_dbg(&adapter->dev, | |
192 | "W83L785TS-S detection failed at 0x%02x.\n", | |
193 | address); | |
194 | goto exit_free; | |
195 | } | |
196 | } | |
197 | ||
198 | if (kind <= 0) { /* identification */ | |
199 | u16 man_id; | |
200 | u8 chip_id; | |
201 | ||
202 | man_id = (w83l785ts_read_value(new_client, | |
203 | W83L785TS_REG_MAN_ID1, 0) << 8) + | |
204 | w83l785ts_read_value(new_client, | |
205 | W83L785TS_REG_MAN_ID2, 0); | |
206 | chip_id = w83l785ts_read_value(new_client, | |
207 | W83L785TS_REG_CHIP_ID, 0); | |
208 | ||
209 | if (man_id == 0x5CA3) { /* Winbond */ | |
210 | if (chip_id == 0x70) { /* W83L785TS-S */ | |
211 | kind = w83l785ts; | |
212 | } | |
213 | } | |
214 | ||
215 | if (kind <= 0) { /* identification failed */ | |
216 | dev_info(&adapter->dev, | |
217 | "Unsupported chip (man_id=0x%04X, " | |
218 | "chip_id=0x%02X).\n", man_id, chip_id); | |
219 | goto exit_free; | |
220 | } | |
221 | } | |
222 | ||
223 | /* We can fill in the remaining client fields. */ | |
224 | strlcpy(new_client->name, "w83l785ts", I2C_NAME_SIZE); | |
225 | data->valid = 0; | |
226 | init_MUTEX(&data->update_lock); | |
227 | ||
228 | /* Default values in case the first read fails (unlikely). */ | |
709439a2 | 229 | data->temp[1] = data->temp[0] = 0; |
1da177e4 LT |
230 | |
231 | /* Tell the I2C layer a new client has arrived. */ | |
232 | if ((err = i2c_attach_client(new_client))) | |
233 | goto exit_free; | |
234 | ||
235 | /* | |
236 | * Initialize the W83L785TS chip | |
237 | * Nothing yet, assume it is already started. | |
238 | */ | |
239 | ||
240 | /* Register sysfs hooks */ | |
943b0830 MH |
241 | data->class_dev = hwmon_device_register(&new_client->dev); |
242 | if (IS_ERR(data->class_dev)) { | |
243 | err = PTR_ERR(data->class_dev); | |
244 | goto exit_detach; | |
245 | } | |
246 | ||
709439a2 JD |
247 | device_create_file(&new_client->dev, |
248 | &sensor_dev_attr_temp1_input.dev_attr); | |
249 | device_create_file(&new_client->dev, | |
250 | &sensor_dev_attr_temp1_max.dev_attr); | |
1da177e4 LT |
251 | |
252 | return 0; | |
253 | ||
943b0830 MH |
254 | exit_detach: |
255 | i2c_detach_client(new_client); | |
1da177e4 LT |
256 | exit_free: |
257 | kfree(data); | |
258 | exit: | |
259 | return err; | |
260 | } | |
261 | ||
262 | static int w83l785ts_detach_client(struct i2c_client *client) | |
263 | { | |
943b0830 | 264 | struct w83l785ts_data *data = i2c_get_clientdata(client); |
1da177e4 LT |
265 | int err; |
266 | ||
943b0830 MH |
267 | hwmon_device_unregister(data->class_dev); |
268 | ||
7bef5594 | 269 | if ((err = i2c_detach_client(client))) |
1da177e4 | 270 | return err; |
1da177e4 | 271 | |
943b0830 | 272 | kfree(data); |
1da177e4 LT |
273 | return 0; |
274 | } | |
275 | ||
276 | static u8 w83l785ts_read_value(struct i2c_client *client, u8 reg, u8 defval) | |
277 | { | |
278 | int value, i; | |
279 | ||
280 | /* Frequent read errors have been reported on Asus boards, so we | |
281 | * retry on read errors. If it still fails (unlikely), return the | |
282 | * default value requested by the caller. */ | |
283 | for (i = 1; i <= MAX_RETRIES; i++) { | |
284 | value = i2c_smbus_read_byte_data(client, reg); | |
285 | if (value >= 0) { | |
286 | dev_dbg(&client->dev, "Read 0x%02x from register " | |
287 | "0x%02x.\n", value, reg); | |
288 | return value; | |
289 | } | |
290 | dev_dbg(&client->dev, "Read failed, will retry in %d.\n", i); | |
291 | msleep(i); | |
292 | } | |
293 | ||
294 | dev_err(&client->dev, "Couldn't read value from register 0x%02x. " | |
295 | "Please report.\n", reg); | |
296 | return defval; | |
297 | } | |
298 | ||
299 | static struct w83l785ts_data *w83l785ts_update_device(struct device *dev) | |
300 | { | |
301 | struct i2c_client *client = to_i2c_client(dev); | |
302 | struct w83l785ts_data *data = i2c_get_clientdata(client); | |
303 | ||
304 | down(&data->update_lock); | |
305 | ||
306 | if (!data->valid || time_after(jiffies, data->last_updated + HZ * 2)) { | |
307 | dev_dbg(&client->dev, "Updating w83l785ts data.\n"); | |
709439a2 JD |
308 | data->temp[0] = w83l785ts_read_value(client, |
309 | W83L785TS_REG_TEMP, data->temp[0]); | |
310 | data->temp[1] = w83l785ts_read_value(client, | |
311 | W83L785TS_REG_TEMP_OVER, data->temp[1]); | |
1da177e4 LT |
312 | |
313 | data->last_updated = jiffies; | |
314 | data->valid = 1; | |
315 | } | |
316 | ||
317 | up(&data->update_lock); | |
318 | ||
319 | return data; | |
320 | } | |
321 | ||
322 | static int __init sensors_w83l785ts_init(void) | |
323 | { | |
324 | return i2c_add_driver(&w83l785ts_driver); | |
325 | } | |
326 | ||
327 | static void __exit sensors_w83l785ts_exit(void) | |
328 | { | |
329 | i2c_del_driver(&w83l785ts_driver); | |
330 | } | |
331 | ||
332 | MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>"); | |
333 | MODULE_DESCRIPTION("W83L785TS-S driver"); | |
334 | MODULE_LICENSE("GPL"); | |
335 | ||
336 | module_init(sensors_w83l785ts_init); | |
337 | module_exit(sensors_w83l785ts_exit); |