1 /*
2 * adm1021.c - Part of lm_sensors, Linux kernel modules for hardware
3 * monitoring
4 * Copyright (c) 1998, 1999 Frodo Looijaard <frodol@dds.nl> and
5 * Philip Edelbrock <phil@netroedge.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/slab.h>
25 #include <linux/jiffies.h>
26 #include <linux/i2c.h>
27 #include <linux/hwmon.h>
28 #include <linux/hwmon-sysfs.h>
29 #include <linux/err.h>
30 #include <linux/mutex.h>
31
32
33 /* Addresses to scan */
34 static const unsigned short normal_i2c[] = {
35 0x18, 0x19, 0x1a, 0x29, 0x2a, 0x2b, 0x4c, 0x4d, 0x4e, I2C_CLIENT_END };
36
37 enum chips {
38 adm1021, adm1023, max1617, max1617a, thmc10, lm84, gl523sm, mc1066 };
39
40 /* adm1021 constants specified below */
41
42 /* The adm1021 registers */
43 /* Read-only */
44 /* For nr in 0-1 */
45 #define ADM1021_REG_TEMP(nr) (nr)
46 #define ADM1021_REG_STATUS 0x02
47 /* 0x41 = AD, 0x49 = TI, 0x4D = Maxim, 0x23 = Genesys , 0x54 = Onsemi */
48 #define ADM1021_REG_MAN_ID 0xFE
49 /* ADM1021 = 0x0X, ADM1023 = 0x3X */
50 #define ADM1021_REG_DEV_ID 0xFF
51 /* These use different addresses for reading/writing */
52 #define ADM1021_REG_CONFIG_R 0x03
53 #define ADM1021_REG_CONFIG_W 0x09
54 #define ADM1021_REG_CONV_RATE_R 0x04
55 #define ADM1021_REG_CONV_RATE_W 0x0A
56 /* These are for the ADM1023's additional precision on the remote temp sensor */
57 #define ADM1023_REG_REM_TEMP_PREC 0x10
58 #define ADM1023_REG_REM_OFFSET 0x11
59 #define ADM1023_REG_REM_OFFSET_PREC 0x12
60 #define ADM1023_REG_REM_TOS_PREC 0x13
61 #define ADM1023_REG_REM_THYST_PREC 0x14
62 /* limits */
63 /* For nr in 0-1 */
64 #define ADM1021_REG_TOS_R(nr) (0x05 + 2 * (nr))
65 #define ADM1021_REG_TOS_W(nr) (0x0B + 2 * (nr))
66 #define ADM1021_REG_THYST_R(nr) (0x06 + 2 * (nr))
67 #define ADM1021_REG_THYST_W(nr) (0x0C + 2 * (nr))
68 /* write-only */
69 #define ADM1021_REG_ONESHOT 0x0F
70
71 /* Initial values */
72
73 /*
74 * Note: Even though I left the low and high limits named os and hyst,
75 * they don't quite work like a thermostat the way the LM75 does. I.e.,
76 * a lower temp than THYST actually triggers an alarm instead of
77 * clearing it. Weird, ey? --Phil
78 */
79
80 /* Each client has this additional data */
81 struct adm1021_data {
82 struct device *hwmon_dev;
83 enum chips type;
84
85 struct mutex update_lock;
86 char valid; /* !=0 if following fields are valid */
87 char low_power; /* !=0 if device in low power mode */
88 unsigned long last_updated; /* In jiffies */
89
90 int temp_max[2]; /* Register values */
91 int temp_min[2];
92 int temp[2];
93 u8 alarms;
94 /* Special values for ADM1023 only */
95 u8 remote_temp_offset;
96 u8 remote_temp_offset_prec;
97 };
98
99 static int adm1021_probe(struct i2c_client *client,
100 const struct i2c_device_id *id);
101 static int adm1021_detect(struct i2c_client *client,
102 struct i2c_board_info *info);
103 static void adm1021_init_client(struct i2c_client *client);
104 static int adm1021_remove(struct i2c_client *client);
105 static struct adm1021_data *adm1021_update_device(struct device *dev);
106
107 /* (amalysh) read only mode, otherwise any limit's writing confuse BIOS */
108 static bool read_only;
109
110
111 static const struct i2c_device_id adm1021_id[] = {
112 { "adm1021", adm1021 },
113 { "adm1023", adm1023 },
114 { "max1617", max1617 },
115 { "max1617a", max1617a },
116 { "thmc10", thmc10 },
117 { "lm84", lm84 },
118 { "gl523sm", gl523sm },
119 { "mc1066", mc1066 },
120 { }
121 };
122 MODULE_DEVICE_TABLE(i2c, adm1021_id);
123
124 /* This is the driver that will be inserted */
125 static struct i2c_driver adm1021_driver = {
126 .class = I2C_CLASS_HWMON,
127 .driver = {
128 .name = "adm1021",
129 },
130 .probe = adm1021_probe,
131 .remove = adm1021_remove,
132 .id_table = adm1021_id,
133 .detect = adm1021_detect,
134 .address_list = normal_i2c,
135 };
136
show_temp(struct device * dev,struct device_attribute * devattr,char * buf)137 static ssize_t show_temp(struct device *dev,
138 struct device_attribute *devattr, char *buf)
139 {
140 int index = to_sensor_dev_attr(devattr)->index;
141 struct adm1021_data *data = adm1021_update_device(dev);
142
143 return sprintf(buf, "%d\n", data->temp[index]);
144 }
145
show_temp_max(struct device * dev,struct device_attribute * devattr,char * buf)146 static ssize_t show_temp_max(struct device *dev,
147 struct device_attribute *devattr, char *buf)
148 {
149 int index = to_sensor_dev_attr(devattr)->index;
150 struct adm1021_data *data = adm1021_update_device(dev);
151
152 return sprintf(buf, "%d\n", data->temp_max[index]);
153 }
154
show_temp_min(struct device * dev,struct device_attribute * devattr,char * buf)155 static ssize_t show_temp_min(struct device *dev,
156 struct device_attribute *devattr, char *buf)
157 {
158 int index = to_sensor_dev_attr(devattr)->index;
159 struct adm1021_data *data = adm1021_update_device(dev);
160
161 return sprintf(buf, "%d\n", data->temp_min[index]);
162 }
163
show_alarm(struct device * dev,struct device_attribute * attr,char * buf)164 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
165 char *buf)
166 {
167 int index = to_sensor_dev_attr(attr)->index;
168 struct adm1021_data *data = adm1021_update_device(dev);
169 return sprintf(buf, "%u\n", (data->alarms >> index) & 1);
170 }
171
show_alarms(struct device * dev,struct device_attribute * attr,char * buf)172 static ssize_t show_alarms(struct device *dev,
173 struct device_attribute *attr,
174 char *buf)
175 {
176 struct adm1021_data *data = adm1021_update_device(dev);
177 return sprintf(buf, "%u\n", data->alarms);
178 }
179
set_temp_max(struct device * dev,struct device_attribute * devattr,const char * buf,size_t count)180 static ssize_t set_temp_max(struct device *dev,
181 struct device_attribute *devattr,
182 const char *buf, size_t count)
183 {
184 int index = to_sensor_dev_attr(devattr)->index;
185 struct i2c_client *client = to_i2c_client(dev);
186 struct adm1021_data *data = i2c_get_clientdata(client);
187 long temp;
188 int err;
189
190 err = kstrtol(buf, 10, &temp);
191 if (err)
192 return err;
193 temp /= 1000;
194
195 mutex_lock(&data->update_lock);
196 data->temp_max[index] = SENSORS_LIMIT(temp, -128, 127);
197 if (!read_only)
198 i2c_smbus_write_byte_data(client, ADM1021_REG_TOS_W(index),
199 data->temp_max[index]);
200 mutex_unlock(&data->update_lock);
201
202 return count;
203 }
204
set_temp_min(struct device * dev,struct device_attribute * devattr,const char * buf,size_t count)205 static ssize_t set_temp_min(struct device *dev,
206 struct device_attribute *devattr,
207 const char *buf, size_t count)
208 {
209 int index = to_sensor_dev_attr(devattr)->index;
210 struct i2c_client *client = to_i2c_client(dev);
211 struct adm1021_data *data = i2c_get_clientdata(client);
212 long temp;
213 int err;
214
215 err = kstrtol(buf, 10, &temp);
216 if (err)
217 return err;
218 temp /= 1000;
219
220 mutex_lock(&data->update_lock);
221 data->temp_min[index] = SENSORS_LIMIT(temp, -128, 127);
222 if (!read_only)
223 i2c_smbus_write_byte_data(client, ADM1021_REG_THYST_W(index),
224 data->temp_min[index]);
225 mutex_unlock(&data->update_lock);
226
227 return count;
228 }
229
show_low_power(struct device * dev,struct device_attribute * devattr,char * buf)230 static ssize_t show_low_power(struct device *dev,
231 struct device_attribute *devattr, char *buf)
232 {
233 struct adm1021_data *data = adm1021_update_device(dev);
234 return sprintf(buf, "%d\n", data->low_power);
235 }
236
set_low_power(struct device * dev,struct device_attribute * devattr,const char * buf,size_t count)237 static ssize_t set_low_power(struct device *dev,
238 struct device_attribute *devattr,
239 const char *buf, size_t count)
240 {
241 struct i2c_client *client = to_i2c_client(dev);
242 struct adm1021_data *data = i2c_get_clientdata(client);
243 char low_power;
244 unsigned long val;
245 int err;
246
247 err = kstrtoul(buf, 10, &val);
248 if (err)
249 return err;
250 low_power = val != 0;
251
252 mutex_lock(&data->update_lock);
253 if (low_power != data->low_power) {
254 int config = i2c_smbus_read_byte_data(
255 client, ADM1021_REG_CONFIG_R);
256 data->low_power = low_power;
257 i2c_smbus_write_byte_data(client, ADM1021_REG_CONFIG_W,
258 (config & 0xBF) | (low_power << 6));
259 }
260 mutex_unlock(&data->update_lock);
261
262 return count;
263 }
264
265
266 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
267 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp_max,
268 set_temp_max, 0);
269 static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp_min,
270 set_temp_min, 0);
271 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
272 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp_max,
273 set_temp_max, 1);
274 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp_min,
275 set_temp_min, 1);
276 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
277 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, 5);
278 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
279 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
280 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
281
282 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
283 static DEVICE_ATTR(low_power, S_IWUSR | S_IRUGO, show_low_power, set_low_power);
284
285 static struct attribute *adm1021_attributes[] = {
286 &sensor_dev_attr_temp1_max.dev_attr.attr,
287 &sensor_dev_attr_temp1_min.dev_attr.attr,
288 &sensor_dev_attr_temp1_input.dev_attr.attr,
289 &sensor_dev_attr_temp2_max.dev_attr.attr,
290 &sensor_dev_attr_temp2_min.dev_attr.attr,
291 &sensor_dev_attr_temp2_input.dev_attr.attr,
292 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
293 &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
294 &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
295 &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
296 &sensor_dev_attr_temp2_fault.dev_attr.attr,
297 &dev_attr_alarms.attr,
298 &dev_attr_low_power.attr,
299 NULL
300 };
301
302 static const struct attribute_group adm1021_group = {
303 .attrs = adm1021_attributes,
304 };
305
306 /* Return 0 if detection is successful, -ENODEV otherwise */
adm1021_detect(struct i2c_client * client,struct i2c_board_info * info)307 static int adm1021_detect(struct i2c_client *client,
308 struct i2c_board_info *info)
309 {
310 struct i2c_adapter *adapter = client->adapter;
311 const char *type_name;
312 int conv_rate, status, config, man_id, dev_id;
313
314 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
315 pr_debug("adm1021: detect failed, "
316 "smbus byte data not supported!\n");
317 return -ENODEV;
318 }
319
320 status = i2c_smbus_read_byte_data(client, ADM1021_REG_STATUS);
321 conv_rate = i2c_smbus_read_byte_data(client,
322 ADM1021_REG_CONV_RATE_R);
323 config = i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R);
324
325 /* Check unused bits */
326 if ((status & 0x03) || (config & 0x3F) || (conv_rate & 0xF8)) {
327 pr_debug("adm1021: detect failed, chip not detected!\n");
328 return -ENODEV;
329 }
330
331 /* Determine the chip type. */
332 man_id = i2c_smbus_read_byte_data(client, ADM1021_REG_MAN_ID);
333 dev_id = i2c_smbus_read_byte_data(client, ADM1021_REG_DEV_ID);
334
335 if (man_id < 0 || dev_id < 0)
336 return -ENODEV;
337
338 if (man_id == 0x4d && dev_id == 0x01)
339 type_name = "max1617a";
340 else if (man_id == 0x41) {
341 if ((dev_id & 0xF0) == 0x30)
342 type_name = "adm1023";
343 else if ((dev_id & 0xF0) == 0x00)
344 type_name = "adm1021";
345 else
346 return -ENODEV;
347 } else if (man_id == 0x49)
348 type_name = "thmc10";
349 else if (man_id == 0x23)
350 type_name = "gl523sm";
351 else if (man_id == 0x54)
352 type_name = "mc1066";
353 else {
354 int lte, rte, lhi, rhi, llo, rlo;
355
356 /* extra checks for LM84 and MAX1617 to avoid misdetections */
357
358 llo = i2c_smbus_read_byte_data(client, ADM1021_REG_THYST_R(0));
359 rlo = i2c_smbus_read_byte_data(client, ADM1021_REG_THYST_R(1));
360
361 /* fail if any of the additional register reads failed */
362 if (llo < 0 || rlo < 0)
363 return -ENODEV;
364
365 lte = i2c_smbus_read_byte_data(client, ADM1021_REG_TEMP(0));
366 rte = i2c_smbus_read_byte_data(client, ADM1021_REG_TEMP(1));
367 lhi = i2c_smbus_read_byte_data(client, ADM1021_REG_TOS_R(0));
368 rhi = i2c_smbus_read_byte_data(client, ADM1021_REG_TOS_R(1));
369
370 /*
371 * Fail for negative temperatures and negative high limits.
372 * This check also catches read errors on the tested registers.
373 */
374 if ((s8)lte < 0 || (s8)rte < 0 || (s8)lhi < 0 || (s8)rhi < 0)
375 return -ENODEV;
376
377 /* fail if all registers hold the same value */
378 if (lte == rte && lte == lhi && lte == rhi && lte == llo
379 && lte == rlo)
380 return -ENODEV;
381
382 /*
383 * LM84 Mfr ID is in a different place,
384 * and it has more unused bits.
385 */
386 if (conv_rate == 0x00
387 && (config & 0x7F) == 0x00
388 && (status & 0xAB) == 0x00) {
389 type_name = "lm84";
390 } else {
391 /* fail if low limits are larger than high limits */
392 if ((s8)llo > lhi || (s8)rlo > rhi)
393 return -ENODEV;
394 type_name = "max1617";
395 }
396 }
397
398 pr_debug("adm1021: Detected chip %s at adapter %d, address 0x%02x.\n",
399 type_name, i2c_adapter_id(adapter), client->addr);
400 strlcpy(info->type, type_name, I2C_NAME_SIZE);
401
402 return 0;
403 }
404
adm1021_probe(struct i2c_client * client,const struct i2c_device_id * id)405 static int adm1021_probe(struct i2c_client *client,
406 const struct i2c_device_id *id)
407 {
408 struct adm1021_data *data;
409 int err;
410
411 data = kzalloc(sizeof(struct adm1021_data), GFP_KERNEL);
412 if (!data) {
413 pr_debug("adm1021: detect failed, kzalloc failed!\n");
414 err = -ENOMEM;
415 goto error0;
416 }
417
418 i2c_set_clientdata(client, data);
419 data->type = id->driver_data;
420 mutex_init(&data->update_lock);
421
422 /* Initialize the ADM1021 chip */
423 if (data->type != lm84 && !read_only)
424 adm1021_init_client(client);
425
426 /* Register sysfs hooks */
427 err = sysfs_create_group(&client->dev.kobj, &adm1021_group);
428 if (err)
429 goto error1;
430
431 data->hwmon_dev = hwmon_device_register(&client->dev);
432 if (IS_ERR(data->hwmon_dev)) {
433 err = PTR_ERR(data->hwmon_dev);
434 goto error3;
435 }
436
437 return 0;
438
439 error3:
440 sysfs_remove_group(&client->dev.kobj, &adm1021_group);
441 error1:
442 kfree(data);
443 error0:
444 return err;
445 }
446
adm1021_init_client(struct i2c_client * client)447 static void adm1021_init_client(struct i2c_client *client)
448 {
449 /* Enable ADC and disable suspend mode */
450 i2c_smbus_write_byte_data(client, ADM1021_REG_CONFIG_W,
451 i2c_smbus_read_byte_data(client, ADM1021_REG_CONFIG_R) & 0xBF);
452 /* Set Conversion rate to 1/sec (this can be tinkered with) */
453 i2c_smbus_write_byte_data(client, ADM1021_REG_CONV_RATE_W, 0x04);
454 }
455
adm1021_remove(struct i2c_client * client)456 static int adm1021_remove(struct i2c_client *client)
457 {
458 struct adm1021_data *data = i2c_get_clientdata(client);
459
460 hwmon_device_unregister(data->hwmon_dev);
461 sysfs_remove_group(&client->dev.kobj, &adm1021_group);
462
463 kfree(data);
464 return 0;
465 }
466
adm1021_update_device(struct device * dev)467 static struct adm1021_data *adm1021_update_device(struct device *dev)
468 {
469 struct i2c_client *client = to_i2c_client(dev);
470 struct adm1021_data *data = i2c_get_clientdata(client);
471
472 mutex_lock(&data->update_lock);
473
474 if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
475 || !data->valid) {
476 int i;
477
478 dev_dbg(&client->dev, "Starting adm1021 update\n");
479
480 for (i = 0; i < 2; i++) {
481 data->temp[i] = 1000 *
482 (s8) i2c_smbus_read_byte_data(
483 client, ADM1021_REG_TEMP(i));
484 data->temp_max[i] = 1000 *
485 (s8) i2c_smbus_read_byte_data(
486 client, ADM1021_REG_TOS_R(i));
487 data->temp_min[i] = 1000 *
488 (s8) i2c_smbus_read_byte_data(
489 client, ADM1021_REG_THYST_R(i));
490 }
491 data->alarms = i2c_smbus_read_byte_data(client,
492 ADM1021_REG_STATUS) & 0x7c;
493 if (data->type == adm1023) {
494 /*
495 * The ADM1023 provides 3 extra bits of precision for
496 * the remote sensor in extra registers.
497 */
498 data->temp[1] += 125 * (i2c_smbus_read_byte_data(
499 client, ADM1023_REG_REM_TEMP_PREC) >> 5);
500 data->temp_max[1] += 125 * (i2c_smbus_read_byte_data(
501 client, ADM1023_REG_REM_TOS_PREC) >> 5);
502 data->temp_min[1] += 125 * (i2c_smbus_read_byte_data(
503 client, ADM1023_REG_REM_THYST_PREC) >> 5);
504 data->remote_temp_offset =
505 i2c_smbus_read_byte_data(client,
506 ADM1023_REG_REM_OFFSET);
507 data->remote_temp_offset_prec =
508 i2c_smbus_read_byte_data(client,
509 ADM1023_REG_REM_OFFSET_PREC);
510 }
511 data->last_updated = jiffies;
512 data->valid = 1;
513 }
514
515 mutex_unlock(&data->update_lock);
516
517 return data;
518 }
519
520 module_i2c_driver(adm1021_driver);
521
522 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl> and "
523 "Philip Edelbrock <phil@netroedge.com>");
524 MODULE_DESCRIPTION("adm1021 driver");
525 MODULE_LICENSE("GPL");
526
527 module_param(read_only, bool, 0);
528 MODULE_PARM_DESC(read_only, "Don't set any values, read only mode");
529