Commit | Line | Data |
---|---|---|
cae2caae CL |
1 | /* |
2 | * adm1029.c - Part of lm_sensors, Linux kernel modules for hardware monitoring | |
3 | * | |
4 | * Copyright (C) 2006 Corentin LABBE <corentin.labbe@geomatys.fr> | |
5 | * | |
6 | * Based on LM83 Driver by Jean Delvare <khali@linux-fr.org> | |
7 | * | |
8 | * Give only processor, motherboard temperatures and fan tachs | |
9 | * Very rare chip please let me know if you use it | |
10 | * | |
11 | * http://www.analog.com/UploadedFiles/Data_Sheets/ADM1029.pdf | |
12 | * | |
13 | * | |
14 | * This program is free software; you can redistribute it and/or modify | |
15 | * it under the terms of the GNU General Public License as published by | |
16 | * the Free Software Foundation version 2 of the License | |
17 | * | |
18 | * This program is distributed in the hope that it will be useful, | |
19 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | * GNU General Public License for more details. | |
22 | * | |
23 | * You should have received a copy of the GNU General Public License | |
24 | * along with this program; if not, write to the Free Software | |
25 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
26 | */ | |
27 | ||
28 | #include <linux/module.h> | |
29 | #include <linux/init.h> | |
30 | #include <linux/slab.h> | |
31 | #include <linux/jiffies.h> | |
32 | #include <linux/i2c.h> | |
33 | #include <linux/hwmon-sysfs.h> | |
34 | #include <linux/hwmon.h> | |
35 | #include <linux/err.h> | |
36 | #include <linux/mutex.h> | |
37 | ||
38 | /* | |
39 | * Addresses to scan | |
40 | */ | |
41 | ||
25e9c86d MH |
42 | static const unsigned short normal_i2c[] = { 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, |
43 | 0x2e, 0x2f, I2C_CLIENT_END | |
cae2caae CL |
44 | }; |
45 | ||
46 | /* | |
47 | * Insmod parameters | |
48 | */ | |
49 | ||
50 | I2C_CLIENT_INSMOD_1(adm1029); | |
51 | ||
52 | /* | |
53 | * The ADM1029 registers | |
54 | * Manufacturer ID is 0x41 for Analog Devices | |
55 | */ | |
56 | ||
57 | #define ADM1029_REG_MAN_ID 0x0D | |
58 | #define ADM1029_REG_CHIP_ID 0x0E | |
59 | #define ADM1029_REG_CONFIG 0x01 | |
60 | #define ADM1029_REG_NB_FAN_SUPPORT 0x02 | |
61 | ||
62 | #define ADM1029_REG_TEMP_DEVICES_INSTALLED 0x06 | |
63 | ||
64 | #define ADM1029_REG_LOCAL_TEMP 0xA0 | |
65 | #define ADM1029_REG_REMOTE1_TEMP 0xA1 | |
66 | #define ADM1029_REG_REMOTE2_TEMP 0xA2 | |
67 | ||
68 | #define ADM1029_REG_LOCAL_TEMP_HIGH 0x90 | |
69 | #define ADM1029_REG_REMOTE1_TEMP_HIGH 0x91 | |
70 | #define ADM1029_REG_REMOTE2_TEMP_HIGH 0x92 | |
71 | ||
72 | #define ADM1029_REG_LOCAL_TEMP_LOW 0x98 | |
73 | #define ADM1029_REG_REMOTE1_TEMP_LOW 0x99 | |
74 | #define ADM1029_REG_REMOTE2_TEMP_LOW 0x9A | |
75 | ||
76 | #define ADM1029_REG_FAN1 0x70 | |
77 | #define ADM1029_REG_FAN2 0x71 | |
78 | ||
79 | #define ADM1029_REG_FAN1_MIN 0x78 | |
80 | #define ADM1029_REG_FAN2_MIN 0x79 | |
81 | ||
82 | #define ADM1029_REG_FAN1_CONFIG 0x68 | |
83 | #define ADM1029_REG_FAN2_CONFIG 0x69 | |
84 | ||
85 | #define TEMP_FROM_REG(val) ((val) * 1000) | |
86 | ||
87 | #define DIV_FROM_REG(val) ( 1 << (((val) >> 6) - 1)) | |
88 | ||
89 | /* Registers to be checked by adm1029_update_device() */ | |
90 | static const u8 ADM1029_REG_TEMP[] = { | |
91 | ADM1029_REG_LOCAL_TEMP, | |
92 | ADM1029_REG_REMOTE1_TEMP, | |
93 | ADM1029_REG_REMOTE2_TEMP, | |
94 | ADM1029_REG_LOCAL_TEMP_HIGH, | |
95 | ADM1029_REG_REMOTE1_TEMP_HIGH, | |
96 | ADM1029_REG_REMOTE2_TEMP_HIGH, | |
97 | ADM1029_REG_LOCAL_TEMP_LOW, | |
98 | ADM1029_REG_REMOTE1_TEMP_LOW, | |
99 | ADM1029_REG_REMOTE2_TEMP_LOW, | |
100 | }; | |
101 | ||
102 | static const u8 ADM1029_REG_FAN[] = { | |
103 | ADM1029_REG_FAN1, | |
104 | ADM1029_REG_FAN2, | |
105 | ADM1029_REG_FAN1_MIN, | |
106 | ADM1029_REG_FAN2_MIN, | |
107 | }; | |
108 | ||
109 | static const u8 ADM1029_REG_FAN_DIV[] = { | |
110 | ADM1029_REG_FAN1_CONFIG, | |
111 | ADM1029_REG_FAN2_CONFIG, | |
112 | }; | |
113 | ||
114 | /* | |
115 | * Functions declaration | |
116 | */ | |
117 | ||
118 | static int adm1029_attach_adapter(struct i2c_adapter *adapter); | |
119 | static int adm1029_detect(struct i2c_adapter *adapter, int address, int kind); | |
120 | static int adm1029_detach_client(struct i2c_client *client); | |
121 | static struct adm1029_data *adm1029_update_device(struct device *dev); | |
122 | static int adm1029_init_client(struct i2c_client *client); | |
123 | ||
124 | /* | |
125 | * Driver data (common to all clients) | |
126 | */ | |
127 | ||
128 | static struct i2c_driver adm1029_driver = { | |
129 | .driver = { | |
130 | .name = "adm1029", | |
131 | }, | |
132 | .attach_adapter = adm1029_attach_adapter, | |
133 | .detach_client = adm1029_detach_client, | |
134 | }; | |
135 | ||
136 | /* | |
137 | * Client data (each client gets its own) | |
138 | */ | |
139 | ||
140 | struct adm1029_data { | |
141 | struct i2c_client client; | |
1beeffe4 | 142 | struct device *hwmon_dev; |
cae2caae CL |
143 | struct mutex update_lock; |
144 | char valid; /* zero until following fields are valid */ | |
145 | unsigned long last_updated; /* in jiffies */ | |
146 | ||
147 | /* registers values, signed for temperature, unsigned for other stuff */ | |
148 | s8 temp[ARRAY_SIZE(ADM1029_REG_TEMP)]; | |
149 | u8 fan[ARRAY_SIZE(ADM1029_REG_FAN)]; | |
150 | u8 fan_div[ARRAY_SIZE(ADM1029_REG_FAN_DIV)]; | |
151 | }; | |
152 | ||
153 | /* | |
154 | * Sysfs stuff | |
155 | */ | |
156 | ||
157 | static ssize_t | |
158 | show_temp(struct device *dev, struct device_attribute *devattr, char *buf) | |
159 | { | |
160 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); | |
161 | struct adm1029_data *data = adm1029_update_device(dev); | |
162 | return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index])); | |
163 | } | |
164 | ||
165 | static ssize_t | |
166 | show_fan(struct device *dev, struct device_attribute *devattr, char *buf) | |
167 | { | |
168 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); | |
169 | struct adm1029_data *data = adm1029_update_device(dev); | |
170 | u16 val; | |
171 | if (data->fan[attr->index] == 0 || data->fan_div[attr->index] == 0 | |
172 | || data->fan[attr->index] == 255) { | |
173 | return sprintf(buf, "0\n"); | |
174 | } | |
175 | ||
176 | val = 1880 * 120 / DIV_FROM_REG(data->fan_div[attr->index]) | |
177 | / data->fan[attr->index]; | |
178 | return sprintf(buf, "%d\n", val); | |
179 | } | |
180 | ||
181 | static ssize_t | |
182 | show_fan_div(struct device *dev, struct device_attribute *devattr, char *buf) | |
183 | { | |
184 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); | |
185 | struct adm1029_data *data = adm1029_update_device(dev); | |
186 | if (data->fan_div[attr->index] == 0) | |
187 | return sprintf(buf, "0\n"); | |
188 | return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[attr->index])); | |
189 | } | |
190 | ||
191 | static ssize_t set_fan_div(struct device *dev, | |
192 | struct device_attribute *devattr, const char *buf, size_t count) | |
193 | { | |
194 | struct i2c_client *client = to_i2c_client(dev); | |
195 | struct adm1029_data *data = i2c_get_clientdata(client); | |
196 | struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr); | |
197 | long val = simple_strtol(buf, NULL, 10); | |
198 | u8 reg; | |
199 | ||
200 | mutex_lock(&data->update_lock); | |
201 | ||
202 | /*Read actual config */ | |
203 | reg = i2c_smbus_read_byte_data(client, | |
204 | ADM1029_REG_FAN_DIV[attr->index]); | |
205 | ||
206 | switch (val) { | |
207 | case 1: | |
208 | val = 1; | |
209 | break; | |
210 | case 2: | |
211 | val = 2; | |
212 | break; | |
213 | case 4: | |
214 | val = 3; | |
215 | break; | |
216 | default: | |
217 | mutex_unlock(&data->update_lock); | |
218 | dev_err(&client->dev, "fan_div value %ld not " | |
219 | "supported. Choose one of 1, 2 or 4!\n", val); | |
220 | return -EINVAL; | |
221 | } | |
222 | /* Update the value */ | |
223 | reg = (reg & 0x3F) | (val << 6); | |
224 | ||
225 | /* Write value */ | |
226 | i2c_smbus_write_byte_data(client, | |
227 | ADM1029_REG_FAN_DIV[attr->index], reg); | |
228 | mutex_unlock(&data->update_lock); | |
229 | ||
230 | return count; | |
231 | } | |
232 | ||
233 | /* | |
234 | Access rights on sysfs, S_IRUGO stand for Is Readable by User, Group and Others | |
235 | S_IWUSR stand for Is Writable by User | |
236 | */ | |
237 | static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0); | |
238 | static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1); | |
239 | static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2); | |
240 | ||
241 | static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 3); | |
242 | static SENSOR_DEVICE_ATTR(temp2_max, S_IRUGO, show_temp, NULL, 4); | |
243 | static SENSOR_DEVICE_ATTR(temp3_max, S_IRUGO, show_temp, NULL, 5); | |
244 | ||
245 | static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO, show_temp, NULL, 6); | |
246 | static SENSOR_DEVICE_ATTR(temp2_min, S_IRUGO, show_temp, NULL, 7); | |
247 | static SENSOR_DEVICE_ATTR(temp3_min, S_IRUGO, show_temp, NULL, 8); | |
248 | ||
249 | static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0); | |
250 | static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan, NULL, 1); | |
251 | ||
252 | static SENSOR_DEVICE_ATTR(fan1_min, S_IRUGO, show_fan, NULL, 2); | |
253 | static SENSOR_DEVICE_ATTR(fan2_min, S_IRUGO, show_fan, NULL, 3); | |
254 | ||
255 | static SENSOR_DEVICE_ATTR(fan1_div, S_IRUGO | S_IWUSR, | |
256 | show_fan_div, set_fan_div, 0); | |
257 | static SENSOR_DEVICE_ATTR(fan2_div, S_IRUGO | S_IWUSR, | |
258 | show_fan_div, set_fan_div, 1); | |
259 | ||
260 | static struct attribute *adm1029_attributes[] = { | |
261 | &sensor_dev_attr_temp1_input.dev_attr.attr, | |
262 | &sensor_dev_attr_temp1_min.dev_attr.attr, | |
263 | &sensor_dev_attr_temp1_max.dev_attr.attr, | |
264 | &sensor_dev_attr_temp2_input.dev_attr.attr, | |
265 | &sensor_dev_attr_temp2_min.dev_attr.attr, | |
266 | &sensor_dev_attr_temp2_max.dev_attr.attr, | |
267 | &sensor_dev_attr_temp3_input.dev_attr.attr, | |
268 | &sensor_dev_attr_temp3_min.dev_attr.attr, | |
269 | &sensor_dev_attr_temp3_max.dev_attr.attr, | |
270 | &sensor_dev_attr_fan1_input.dev_attr.attr, | |
271 | &sensor_dev_attr_fan2_input.dev_attr.attr, | |
272 | &sensor_dev_attr_fan1_min.dev_attr.attr, | |
273 | &sensor_dev_attr_fan2_min.dev_attr.attr, | |
274 | &sensor_dev_attr_fan1_div.dev_attr.attr, | |
275 | &sensor_dev_attr_fan2_div.dev_attr.attr, | |
276 | NULL | |
277 | }; | |
278 | ||
279 | static const struct attribute_group adm1029_group = { | |
280 | .attrs = adm1029_attributes, | |
281 | }; | |
282 | ||
283 | /* | |
284 | * Real code | |
285 | */ | |
286 | ||
287 | static int adm1029_attach_adapter(struct i2c_adapter *adapter) | |
288 | { | |
289 | if (!(adapter->class & I2C_CLASS_HWMON)) | |
290 | return 0; | |
291 | return i2c_probe(adapter, &addr_data, adm1029_detect); | |
292 | } | |
293 | ||
294 | /* | |
295 | * The following function does more than just detection. If detection | |
296 | * succeeds, it also registers the new chip. | |
297 | */ | |
298 | ||
299 | static int adm1029_detect(struct i2c_adapter *adapter, int address, int kind) | |
300 | { | |
301 | struct i2c_client *client; | |
302 | struct adm1029_data *data; | |
303 | int err = 0; | |
304 | const char *name = ""; | |
305 | if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) | |
306 | goto exit; | |
307 | ||
308 | if (!(data = kzalloc(sizeof(struct adm1029_data), GFP_KERNEL))) { | |
309 | err = -ENOMEM; | |
310 | goto exit; | |
311 | } | |
312 | ||
313 | client = &data->client; | |
314 | i2c_set_clientdata(client, data); | |
315 | client->addr = address; | |
316 | client->adapter = adapter; | |
317 | client->driver = &adm1029_driver; | |
318 | ||
319 | /* Now we do the detection and identification. A negative kind | |
320 | * means that the driver was loaded with no force parameter | |
321 | * (default), so we must both detect and identify the chip | |
322 | * (actually there is only one possible kind of chip for now, adm1029). | |
323 | * A zero kind means that the driver was loaded with the force | |
324 | * parameter, the detection step shall be skipped. A positive kind | |
325 | * means that the driver was loaded with the force parameter and a | |
326 | * given kind of chip is requested, so both the detection and the | |
327 | * identification steps are skipped. */ | |
328 | ||
329 | /* Default to an adm1029 if forced */ | |
330 | if (kind == 0) | |
331 | kind = adm1029; | |
332 | ||
333 | /* ADM1029 doesn't have CHIP ID, check just MAN ID | |
334 | * For better detection we check also ADM1029_TEMP_DEVICES_INSTALLED, | |
335 | * ADM1029_REG_NB_FAN_SUPPORT and compare it with possible values | |
336 | * documented | |
337 | */ | |
338 | ||
339 | if (kind <= 0) { /* identification */ | |
340 | u8 man_id, chip_id, temp_devices_installed, nb_fan_support; | |
341 | ||
342 | man_id = i2c_smbus_read_byte_data(client, ADM1029_REG_MAN_ID); | |
343 | chip_id = i2c_smbus_read_byte_data(client, ADM1029_REG_CHIP_ID); | |
344 | temp_devices_installed = i2c_smbus_read_byte_data(client, | |
345 | ADM1029_REG_TEMP_DEVICES_INSTALLED); | |
346 | nb_fan_support = i2c_smbus_read_byte_data(client, | |
347 | ADM1029_REG_NB_FAN_SUPPORT); | |
348 | /* 0x41 is Analog Devices */ | |
349 | if (man_id == 0x41 && (temp_devices_installed & 0xf9) == 0x01 | |
350 | && nb_fan_support == 0x03) { | |
351 | if ((chip_id & 0xF0) == 0x00) { | |
352 | kind = adm1029; | |
353 | } else { | |
354 | /* There are no "official" CHIP ID, so actually | |
355 | * we use Major/Minor revision for that */ | |
356 | printk(KERN_INFO | |
357 | "adm1029: Unknown major revision %x, " | |
358 | "please let us know\n", chip_id); | |
359 | } | |
360 | } | |
361 | ||
362 | if (kind <= 0) { /* identification failed */ | |
363 | pr_debug("adm1029: Unsupported chip (man_id=0x%02X, " | |
364 | "chip_id=0x%02X)\n", man_id, chip_id); | |
365 | goto exit_free; | |
366 | } | |
367 | } | |
368 | ||
369 | if (kind == adm1029) { | |
370 | name = "adm1029"; | |
371 | } | |
372 | ||
373 | /* We can fill in the remaining client fields */ | |
374 | strlcpy(client->name, name, I2C_NAME_SIZE); | |
375 | mutex_init(&data->update_lock); | |
376 | ||
377 | /* Tell the I2C layer a new client has arrived */ | |
378 | if ((err = i2c_attach_client(client))) | |
379 | goto exit_free; | |
380 | ||
381 | /* | |
382 | * Initialize the ADM1029 chip | |
383 | * Check config register | |
384 | */ | |
385 | if (adm1029_init_client(client) == 0) | |
386 | goto exit_detach; | |
387 | ||
388 | /* Register sysfs hooks */ | |
389 | if ((err = sysfs_create_group(&client->dev.kobj, &adm1029_group))) | |
390 | goto exit_detach; | |
391 | ||
1beeffe4 TJ |
392 | data->hwmon_dev = hwmon_device_register(&client->dev); |
393 | if (IS_ERR(data->hwmon_dev)) { | |
394 | err = PTR_ERR(data->hwmon_dev); | |
cae2caae CL |
395 | goto exit_remove_files; |
396 | } | |
397 | ||
398 | return 0; | |
399 | ||
400 | exit_remove_files: | |
401 | sysfs_remove_group(&client->dev.kobj, &adm1029_group); | |
402 | exit_detach: | |
403 | i2c_detach_client(client); | |
404 | exit_free: | |
405 | kfree(data); | |
406 | exit: | |
407 | return err; | |
408 | } | |
409 | ||
410 | static int adm1029_init_client(struct i2c_client *client) | |
411 | { | |
412 | u8 config; | |
413 | config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG); | |
414 | if ((config & 0x10) == 0) { | |
415 | i2c_smbus_write_byte_data(client, ADM1029_REG_CONFIG, | |
416 | config | 0x10); | |
417 | } | |
418 | /* recheck config */ | |
419 | config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG); | |
420 | if ((config & 0x10) == 0) { | |
421 | dev_err(&client->dev, "Initialization failed!\n"); | |
422 | return 0; | |
423 | } | |
424 | return 1; | |
425 | } | |
426 | ||
427 | static int adm1029_detach_client(struct i2c_client *client) | |
428 | { | |
429 | struct adm1029_data *data = i2c_get_clientdata(client); | |
430 | int err; | |
431 | ||
1beeffe4 | 432 | hwmon_device_unregister(data->hwmon_dev); |
cae2caae CL |
433 | sysfs_remove_group(&client->dev.kobj, &adm1029_group); |
434 | ||
435 | if ((err = i2c_detach_client(client))) | |
436 | return err; | |
437 | ||
438 | kfree(data); | |
439 | return 0; | |
440 | } | |
441 | ||
442 | /* | |
443 | function that update the status of the chips (temperature for exemple) | |
444 | */ | |
445 | static struct adm1029_data *adm1029_update_device(struct device *dev) | |
446 | { | |
447 | struct i2c_client *client = to_i2c_client(dev); | |
448 | struct adm1029_data *data = i2c_get_clientdata(client); | |
449 | ||
450 | mutex_lock(&data->update_lock); | |
451 | /* | |
452 | * Use the "cache" Luke, don't recheck values | |
453 | * if there are already checked not a long time later | |
454 | */ | |
455 | if (time_after(jiffies, data->last_updated + HZ * 2) | |
456 | || !data->valid) { | |
457 | int nr; | |
458 | ||
459 | dev_dbg(&client->dev, "Updating adm1029 data\n"); | |
460 | ||
461 | for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_TEMP); nr++) { | |
462 | data->temp[nr] = | |
463 | i2c_smbus_read_byte_data(client, | |
464 | ADM1029_REG_TEMP[nr]); | |
465 | } | |
466 | for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN); nr++) { | |
467 | data->fan[nr] = | |
468 | i2c_smbus_read_byte_data(client, | |
469 | ADM1029_REG_FAN[nr]); | |
470 | } | |
471 | for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN_DIV); nr++) { | |
472 | data->fan_div[nr] = | |
473 | i2c_smbus_read_byte_data(client, | |
474 | ADM1029_REG_FAN_DIV[nr]); | |
475 | } | |
476 | ||
477 | data->last_updated = jiffies; | |
478 | data->valid = 1; | |
479 | } | |
480 | ||
481 | mutex_unlock(&data->update_lock); | |
482 | ||
483 | return data; | |
484 | } | |
485 | ||
486 | /* | |
487 | Common module stuff | |
488 | */ | |
489 | static int __init sensors_adm1029_init(void) | |
490 | { | |
491 | ||
492 | return i2c_add_driver(&adm1029_driver); | |
493 | } | |
494 | ||
495 | static void __exit sensors_adm1029_exit(void) | |
496 | { | |
497 | ||
498 | i2c_del_driver(&adm1029_driver); | |
499 | } | |
500 | ||
501 | MODULE_AUTHOR("Corentin LABBE <corentin.labbe@geomatys.fr>"); | |
502 | MODULE_DESCRIPTION("adm1029 driver"); | |
503 | MODULE_LICENSE("GPL v2"); | |
504 | ||
505 | module_init(sensors_adm1029_init); | |
506 | module_exit(sensors_adm1029_exit); |