Loading...
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
42static const unsigned short normal_i2c[] = { 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d,
43 0x2e, 0x2f, I2C_CLIENT_END
44};
45
46/*
47 * The ADM1029 registers
48 * Manufacturer ID is 0x41 for Analog Devices
49 */
50
51#define ADM1029_REG_MAN_ID 0x0D
52#define ADM1029_REG_CHIP_ID 0x0E
53#define ADM1029_REG_CONFIG 0x01
54#define ADM1029_REG_NB_FAN_SUPPORT 0x02
55
56#define ADM1029_REG_TEMP_DEVICES_INSTALLED 0x06
57
58#define ADM1029_REG_LOCAL_TEMP 0xA0
59#define ADM1029_REG_REMOTE1_TEMP 0xA1
60#define ADM1029_REG_REMOTE2_TEMP 0xA2
61
62#define ADM1029_REG_LOCAL_TEMP_HIGH 0x90
63#define ADM1029_REG_REMOTE1_TEMP_HIGH 0x91
64#define ADM1029_REG_REMOTE2_TEMP_HIGH 0x92
65
66#define ADM1029_REG_LOCAL_TEMP_LOW 0x98
67#define ADM1029_REG_REMOTE1_TEMP_LOW 0x99
68#define ADM1029_REG_REMOTE2_TEMP_LOW 0x9A
69
70#define ADM1029_REG_FAN1 0x70
71#define ADM1029_REG_FAN2 0x71
72
73#define ADM1029_REG_FAN1_MIN 0x78
74#define ADM1029_REG_FAN2_MIN 0x79
75
76#define ADM1029_REG_FAN1_CONFIG 0x68
77#define ADM1029_REG_FAN2_CONFIG 0x69
78
79#define TEMP_FROM_REG(val) ((val) * 1000)
80
81#define DIV_FROM_REG(val) (1 << (((val) >> 6) - 1))
82
83/* Registers to be checked by adm1029_update_device() */
84static const u8 ADM1029_REG_TEMP[] = {
85 ADM1029_REG_LOCAL_TEMP,
86 ADM1029_REG_REMOTE1_TEMP,
87 ADM1029_REG_REMOTE2_TEMP,
88 ADM1029_REG_LOCAL_TEMP_HIGH,
89 ADM1029_REG_REMOTE1_TEMP_HIGH,
90 ADM1029_REG_REMOTE2_TEMP_HIGH,
91 ADM1029_REG_LOCAL_TEMP_LOW,
92 ADM1029_REG_REMOTE1_TEMP_LOW,
93 ADM1029_REG_REMOTE2_TEMP_LOW,
94};
95
96static const u8 ADM1029_REG_FAN[] = {
97 ADM1029_REG_FAN1,
98 ADM1029_REG_FAN2,
99 ADM1029_REG_FAN1_MIN,
100 ADM1029_REG_FAN2_MIN,
101};
102
103static const u8 ADM1029_REG_FAN_DIV[] = {
104 ADM1029_REG_FAN1_CONFIG,
105 ADM1029_REG_FAN2_CONFIG,
106};
107
108/*
109 * Functions declaration
110 */
111
112static int adm1029_probe(struct i2c_client *client,
113 const struct i2c_device_id *id);
114static int adm1029_detect(struct i2c_client *client,
115 struct i2c_board_info *info);
116static int adm1029_remove(struct i2c_client *client);
117static struct adm1029_data *adm1029_update_device(struct device *dev);
118static int adm1029_init_client(struct i2c_client *client);
119
120/*
121 * Driver data (common to all clients)
122 */
123
124static const struct i2c_device_id adm1029_id[] = {
125 { "adm1029", 0 },
126 { }
127};
128MODULE_DEVICE_TABLE(i2c, adm1029_id);
129
130static struct i2c_driver adm1029_driver = {
131 .class = I2C_CLASS_HWMON,
132 .driver = {
133 .name = "adm1029",
134 },
135 .probe = adm1029_probe,
136 .remove = adm1029_remove,
137 .id_table = adm1029_id,
138 .detect = adm1029_detect,
139 .address_list = normal_i2c,
140};
141
142/*
143 * Client data (each client gets its own)
144 */
145
146struct adm1029_data {
147 struct device *hwmon_dev;
148 struct mutex update_lock;
149 char valid; /* zero until following fields are valid */
150 unsigned long last_updated; /* in jiffies */
151
152 /* registers values, signed for temperature, unsigned for other stuff */
153 s8 temp[ARRAY_SIZE(ADM1029_REG_TEMP)];
154 u8 fan[ARRAY_SIZE(ADM1029_REG_FAN)];
155 u8 fan_div[ARRAY_SIZE(ADM1029_REG_FAN_DIV)];
156};
157
158/*
159 * Sysfs stuff
160 */
161
162static ssize_t
163show_temp(struct device *dev, struct device_attribute *devattr, char *buf)
164{
165 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
166 struct adm1029_data *data = adm1029_update_device(dev);
167 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
168}
169
170static ssize_t
171show_fan(struct device *dev, struct device_attribute *devattr, char *buf)
172{
173 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
174 struct adm1029_data *data = adm1029_update_device(dev);
175 u16 val;
176 if (data->fan[attr->index] == 0
177 || (data->fan_div[attr->index] & 0xC0) == 0
178 || data->fan[attr->index] == 255) {
179 return sprintf(buf, "0\n");
180 }
181
182 val = 1880 * 120 / DIV_FROM_REG(data->fan_div[attr->index])
183 / data->fan[attr->index];
184 return sprintf(buf, "%d\n", val);
185}
186
187static ssize_t
188show_fan_div(struct device *dev, struct device_attribute *devattr, char *buf)
189{
190 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
191 struct adm1029_data *data = adm1029_update_device(dev);
192 if ((data->fan_div[attr->index] & 0xC0) == 0)
193 return sprintf(buf, "0\n");
194 return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[attr->index]));
195}
196
197static ssize_t set_fan_div(struct device *dev,
198 struct device_attribute *devattr, const char *buf, size_t count)
199{
200 struct i2c_client *client = to_i2c_client(dev);
201 struct adm1029_data *data = i2c_get_clientdata(client);
202 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
203 u8 reg;
204 long val;
205 int ret = kstrtol(buf, 10, &val);
206 if (ret < 0)
207 return ret;
208
209 mutex_lock(&data->update_lock);
210
211 /*Read actual config */
212 reg = i2c_smbus_read_byte_data(client,
213 ADM1029_REG_FAN_DIV[attr->index]);
214
215 switch (val) {
216 case 1:
217 val = 1;
218 break;
219 case 2:
220 val = 2;
221 break;
222 case 4:
223 val = 3;
224 break;
225 default:
226 mutex_unlock(&data->update_lock);
227 dev_err(&client->dev, "fan_div value %ld not "
228 "supported. Choose one of 1, 2 or 4!\n", val);
229 return -EINVAL;
230 }
231 /* Update the value */
232 reg = (reg & 0x3F) | (val << 6);
233
234 /* Write value */
235 i2c_smbus_write_byte_data(client,
236 ADM1029_REG_FAN_DIV[attr->index], reg);
237 mutex_unlock(&data->update_lock);
238
239 return count;
240}
241
242/*
243 * Access rights on sysfs. S_IRUGO: Is Readable by User, Group and Others
244 * S_IWUSR: Is Writable by User.
245 */
246static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
247static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
248static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
249
250static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 3);
251static SENSOR_DEVICE_ATTR(temp2_max, S_IRUGO, show_temp, NULL, 4);
252static SENSOR_DEVICE_ATTR(temp3_max, S_IRUGO, show_temp, NULL, 5);
253
254static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO, show_temp, NULL, 6);
255static SENSOR_DEVICE_ATTR(temp2_min, S_IRUGO, show_temp, NULL, 7);
256static SENSOR_DEVICE_ATTR(temp3_min, S_IRUGO, show_temp, NULL, 8);
257
258static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
259static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan, NULL, 1);
260
261static SENSOR_DEVICE_ATTR(fan1_min, S_IRUGO, show_fan, NULL, 2);
262static SENSOR_DEVICE_ATTR(fan2_min, S_IRUGO, show_fan, NULL, 3);
263
264static SENSOR_DEVICE_ATTR(fan1_div, S_IRUGO | S_IWUSR,
265 show_fan_div, set_fan_div, 0);
266static SENSOR_DEVICE_ATTR(fan2_div, S_IRUGO | S_IWUSR,
267 show_fan_div, set_fan_div, 1);
268
269static struct attribute *adm1029_attributes[] = {
270 &sensor_dev_attr_temp1_input.dev_attr.attr,
271 &sensor_dev_attr_temp1_min.dev_attr.attr,
272 &sensor_dev_attr_temp1_max.dev_attr.attr,
273 &sensor_dev_attr_temp2_input.dev_attr.attr,
274 &sensor_dev_attr_temp2_min.dev_attr.attr,
275 &sensor_dev_attr_temp2_max.dev_attr.attr,
276 &sensor_dev_attr_temp3_input.dev_attr.attr,
277 &sensor_dev_attr_temp3_min.dev_attr.attr,
278 &sensor_dev_attr_temp3_max.dev_attr.attr,
279 &sensor_dev_attr_fan1_input.dev_attr.attr,
280 &sensor_dev_attr_fan2_input.dev_attr.attr,
281 &sensor_dev_attr_fan1_min.dev_attr.attr,
282 &sensor_dev_attr_fan2_min.dev_attr.attr,
283 &sensor_dev_attr_fan1_div.dev_attr.attr,
284 &sensor_dev_attr_fan2_div.dev_attr.attr,
285 NULL
286};
287
288static const struct attribute_group adm1029_group = {
289 .attrs = adm1029_attributes,
290};
291
292/*
293 * Real code
294 */
295
296/* Return 0 if detection is successful, -ENODEV otherwise */
297static int adm1029_detect(struct i2c_client *client,
298 struct i2c_board_info *info)
299{
300 struct i2c_adapter *adapter = client->adapter;
301 u8 man_id, chip_id, temp_devices_installed, nb_fan_support;
302
303 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
304 return -ENODEV;
305
306 /*
307 * ADM1029 doesn't have CHIP ID, check just MAN ID
308 * For better detection we check also ADM1029_TEMP_DEVICES_INSTALLED,
309 * ADM1029_REG_NB_FAN_SUPPORT and compare it with possible values
310 * documented
311 */
312
313 man_id = i2c_smbus_read_byte_data(client, ADM1029_REG_MAN_ID);
314 chip_id = i2c_smbus_read_byte_data(client, ADM1029_REG_CHIP_ID);
315 temp_devices_installed = i2c_smbus_read_byte_data(client,
316 ADM1029_REG_TEMP_DEVICES_INSTALLED);
317 nb_fan_support = i2c_smbus_read_byte_data(client,
318 ADM1029_REG_NB_FAN_SUPPORT);
319 /* 0x41 is Analog Devices */
320 if (man_id != 0x41 || (temp_devices_installed & 0xf9) != 0x01
321 || nb_fan_support != 0x03)
322 return -ENODEV;
323
324 if ((chip_id & 0xF0) != 0x00) {
325 /*
326 * There are no "official" CHIP ID, so actually
327 * we use Major/Minor revision for that
328 */
329 pr_info("adm1029: Unknown major revision %x, "
330 "please let us know\n", chip_id);
331 return -ENODEV;
332 }
333
334 strlcpy(info->type, "adm1029", I2C_NAME_SIZE);
335
336 return 0;
337}
338
339static int adm1029_probe(struct i2c_client *client,
340 const struct i2c_device_id *id)
341{
342 struct adm1029_data *data;
343 int err;
344
345 data = kzalloc(sizeof(struct adm1029_data), GFP_KERNEL);
346 if (!data) {
347 err = -ENOMEM;
348 goto exit;
349 }
350
351 i2c_set_clientdata(client, data);
352 mutex_init(&data->update_lock);
353
354 /*
355 * Initialize the ADM1029 chip
356 * Check config register
357 */
358 if (adm1029_init_client(client) == 0) {
359 err = -ENODEV;
360 goto exit_free;
361 }
362
363 /* Register sysfs hooks */
364 err = sysfs_create_group(&client->dev.kobj, &adm1029_group);
365 if (err)
366 goto exit_free;
367
368 data->hwmon_dev = hwmon_device_register(&client->dev);
369 if (IS_ERR(data->hwmon_dev)) {
370 err = PTR_ERR(data->hwmon_dev);
371 goto exit_remove_files;
372 }
373
374 return 0;
375
376 exit_remove_files:
377 sysfs_remove_group(&client->dev.kobj, &adm1029_group);
378 exit_free:
379 kfree(data);
380 exit:
381 return err;
382}
383
384static int adm1029_init_client(struct i2c_client *client)
385{
386 u8 config;
387 config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
388 if ((config & 0x10) == 0) {
389 i2c_smbus_write_byte_data(client, ADM1029_REG_CONFIG,
390 config | 0x10);
391 }
392 /* recheck config */
393 config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
394 if ((config & 0x10) == 0) {
395 dev_err(&client->dev, "Initialization failed!\n");
396 return 0;
397 }
398 return 1;
399}
400
401static int adm1029_remove(struct i2c_client *client)
402{
403 struct adm1029_data *data = i2c_get_clientdata(client);
404
405 hwmon_device_unregister(data->hwmon_dev);
406 sysfs_remove_group(&client->dev.kobj, &adm1029_group);
407
408 kfree(data);
409 return 0;
410}
411
412/*
413 * function that update the status of the chips (temperature for example)
414 */
415static struct adm1029_data *adm1029_update_device(struct device *dev)
416{
417 struct i2c_client *client = to_i2c_client(dev);
418 struct adm1029_data *data = i2c_get_clientdata(client);
419
420 mutex_lock(&data->update_lock);
421 /*
422 * Use the "cache" Luke, don't recheck values
423 * if there are already checked not a long time later
424 */
425 if (time_after(jiffies, data->last_updated + HZ * 2)
426 || !data->valid) {
427 int nr;
428
429 dev_dbg(&client->dev, "Updating adm1029 data\n");
430
431 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_TEMP); nr++) {
432 data->temp[nr] =
433 i2c_smbus_read_byte_data(client,
434 ADM1029_REG_TEMP[nr]);
435 }
436 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN); nr++) {
437 data->fan[nr] =
438 i2c_smbus_read_byte_data(client,
439 ADM1029_REG_FAN[nr]);
440 }
441 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN_DIV); nr++) {
442 data->fan_div[nr] =
443 i2c_smbus_read_byte_data(client,
444 ADM1029_REG_FAN_DIV[nr]);
445 }
446
447 data->last_updated = jiffies;
448 data->valid = 1;
449 }
450
451 mutex_unlock(&data->update_lock);
452
453 return data;
454}
455
456module_i2c_driver(adm1029_driver);
457
458MODULE_AUTHOR("Corentin LABBE <corentin.labbe@geomatys.fr>");
459MODULE_DESCRIPTION("adm1029 driver");
460MODULE_LICENSE("GPL v2");