2 * emc2103.c - Support for SMSC EMC2103
3 * Copyright (c) 2010 SMSC
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/slab.h>
23 #include <linux/jiffies.h>
24 #include <linux/i2c.h>
25 #include <linux/hwmon.h>
26 #include <linux/hwmon-sysfs.h>
27 #include <linux/err.h>
28 #include <linux/mutex.h>
30 /* Addresses scanned */
31 static const unsigned short normal_i2c[] = { 0x2E, I2C_CLIENT_END };
33 static const u8 REG_TEMP[4] = { 0x00, 0x02, 0x04, 0x06 };
34 static const u8 REG_TEMP_MIN[4] = { 0x3c, 0x38, 0x39, 0x3a };
35 static const u8 REG_TEMP_MAX[4] = { 0x34, 0x30, 0x31, 0x32 };
37 #define REG_CONF1 0x20
38 #define REG_TEMP_MAX_ALARM 0x24
39 #define REG_TEMP_MIN_ALARM 0x25
40 #define REG_FAN_CONF1 0x42
41 #define REG_FAN_TARGET_LO 0x4c
42 #define REG_FAN_TARGET_HI 0x4d
43 #define REG_FAN_TACH_HI 0x4e
44 #define REG_FAN_TACH_LO 0x4f
45 #define REG_PRODUCT_ID 0xfd
46 #define REG_MFG_ID 0xfe
48 /* equation 4 from datasheet: rpm = (3932160 * multipler) / count */
49 #define FAN_RPM_FACTOR 3932160
52 * 2103-2 and 2103-4's 3rd temperature sensor can be connected to two diodes
53 * in anti-parallel mode, and in this configuration both can be read
54 * independently (so we have 4 temperature inputs). The device can't
55 * detect if it's connected in this mode, so we have to manually enable
56 * it. Default is to leave the device in the state it's already in (-1).
57 * This parameter allows APD mode to be optionally forced on or off
60 module_param(apd, bint, 0);
61 MODULE_PARM_DESC(init, "Set to zero to disable anti-parallel diode mode");
65 u8 fraction; /* 0-7 multiples of 0.125 */
69 struct i2c_client *client;
70 const struct attribute_group *groups[4];
71 struct mutex update_lock;
72 bool valid; /* registers are valid */
74 int temp_count; /* num of temp sensors */
75 unsigned long last_updated; /* in jiffies */
76 struct temperature temp[4]; /* internal + 3 external */
77 s8 temp_min[4]; /* no fractional part */
78 s8 temp_max[4]; /* no fractional part */
86 static int read_u8_from_i2c(struct i2c_client *client, u8 i2c_reg, u8 *output)
88 int status = i2c_smbus_read_byte_data(client, i2c_reg);
90 dev_warn(&client->dev, "reg 0x%02x, err %d\n",
98 static void read_temp_from_i2c(struct i2c_client *client, u8 i2c_reg,
99 struct temperature *temp)
101 u8 degrees, fractional;
103 if (read_u8_from_i2c(client, i2c_reg, °rees) < 0)
106 if (read_u8_from_i2c(client, i2c_reg + 1, &fractional) < 0)
109 temp->degrees = degrees;
110 temp->fraction = (fractional & 0xe0) >> 5;
113 static void read_fan_from_i2c(struct i2c_client *client, u16 *output,
114 u8 hi_addr, u8 lo_addr)
116 u8 high_byte, lo_byte;
118 if (read_u8_from_i2c(client, hi_addr, &high_byte) < 0)
121 if (read_u8_from_i2c(client, lo_addr, &lo_byte) < 0)
124 *output = ((u16)high_byte << 5) | (lo_byte >> 3);
127 static void write_fan_target_to_i2c(struct i2c_client *client, u16 new_target)
129 u8 high_byte = (new_target & 0x1fe0) >> 5;
130 u8 low_byte = (new_target & 0x001f) << 3;
131 i2c_smbus_write_byte_data(client, REG_FAN_TARGET_LO, low_byte);
132 i2c_smbus_write_byte_data(client, REG_FAN_TARGET_HI, high_byte);
135 static void read_fan_config_from_i2c(struct i2c_client *client)
138 struct emc2103_data *data = i2c_get_clientdata(client);
141 if (read_u8_from_i2c(client, REG_FAN_CONF1, &conf1) < 0)
144 data->fan_multiplier = 1 << ((conf1 & 0x60) >> 5);
145 data->fan_rpm_control = (conf1 & 0x80) != 0;
148 static struct emc2103_data *emc2103_update_device(struct device *dev)
150 struct emc2103_data *data = dev_get_drvdata(dev);
151 struct i2c_client *client = data->client;
153 mutex_lock(&data->update_lock);
155 if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
159 for (i = 0; i < data->temp_count; i++) {
160 read_temp_from_i2c(client, REG_TEMP[i], &data->temp[i]);
161 read_u8_from_i2c(client, REG_TEMP_MIN[i],
163 read_u8_from_i2c(client, REG_TEMP_MAX[i],
167 read_u8_from_i2c(client, REG_TEMP_MIN_ALARM,
168 &data->temp_min_alarm);
169 read_u8_from_i2c(client, REG_TEMP_MAX_ALARM,
170 &data->temp_max_alarm);
172 read_fan_from_i2c(client, &data->fan_tach,
173 REG_FAN_TACH_HI, REG_FAN_TACH_LO);
174 read_fan_from_i2c(client, &data->fan_target,
175 REG_FAN_TARGET_HI, REG_FAN_TARGET_LO);
176 read_fan_config_from_i2c(client);
178 data->last_updated = jiffies;
182 mutex_unlock(&data->update_lock);
188 show_temp(struct device *dev, struct device_attribute *da, char *buf)
190 int nr = to_sensor_dev_attr(da)->index;
191 struct emc2103_data *data = emc2103_update_device(dev);
192 int millidegrees = data->temp[nr].degrees * 1000
193 + data->temp[nr].fraction * 125;
194 return sprintf(buf, "%d\n", millidegrees);
198 show_temp_min(struct device *dev, struct device_attribute *da, char *buf)
200 int nr = to_sensor_dev_attr(da)->index;
201 struct emc2103_data *data = emc2103_update_device(dev);
202 int millidegrees = data->temp_min[nr] * 1000;
203 return sprintf(buf, "%d\n", millidegrees);
207 show_temp_max(struct device *dev, struct device_attribute *da, char *buf)
209 int nr = to_sensor_dev_attr(da)->index;
210 struct emc2103_data *data = emc2103_update_device(dev);
211 int millidegrees = data->temp_max[nr] * 1000;
212 return sprintf(buf, "%d\n", millidegrees);
216 show_temp_fault(struct device *dev, struct device_attribute *da, char *buf)
218 int nr = to_sensor_dev_attr(da)->index;
219 struct emc2103_data *data = emc2103_update_device(dev);
220 bool fault = (data->temp[nr].degrees == -128);
221 return sprintf(buf, "%d\n", fault ? 1 : 0);
225 show_temp_min_alarm(struct device *dev, struct device_attribute *da, char *buf)
227 int nr = to_sensor_dev_attr(da)->index;
228 struct emc2103_data *data = emc2103_update_device(dev);
229 bool alarm = data->temp_min_alarm & (1 << nr);
230 return sprintf(buf, "%d\n", alarm ? 1 : 0);
234 show_temp_max_alarm(struct device *dev, struct device_attribute *da, char *buf)
236 int nr = to_sensor_dev_attr(da)->index;
237 struct emc2103_data *data = emc2103_update_device(dev);
238 bool alarm = data->temp_max_alarm & (1 << nr);
239 return sprintf(buf, "%d\n", alarm ? 1 : 0);
242 static ssize_t set_temp_min(struct device *dev, struct device_attribute *da,
243 const char *buf, size_t count)
245 int nr = to_sensor_dev_attr(da)->index;
246 struct emc2103_data *data = dev_get_drvdata(dev);
247 struct i2c_client *client = data->client;
250 int result = kstrtol(buf, 10, &val);
254 val = clamp_val(DIV_ROUND_CLOSEST(val, 1000), -63, 127);
256 mutex_lock(&data->update_lock);
257 data->temp_min[nr] = val;
258 i2c_smbus_write_byte_data(client, REG_TEMP_MIN[nr], val);
259 mutex_unlock(&data->update_lock);
264 static ssize_t set_temp_max(struct device *dev, struct device_attribute *da,
265 const char *buf, size_t count)
267 int nr = to_sensor_dev_attr(da)->index;
268 struct emc2103_data *data = dev_get_drvdata(dev);
269 struct i2c_client *client = data->client;
272 int result = kstrtol(buf, 10, &val);
276 val = clamp_val(DIV_ROUND_CLOSEST(val, 1000), -63, 127);
278 mutex_lock(&data->update_lock);
279 data->temp_max[nr] = val;
280 i2c_smbus_write_byte_data(client, REG_TEMP_MAX[nr], val);
281 mutex_unlock(&data->update_lock);
287 show_fan(struct device *dev, struct device_attribute *da, char *buf)
289 struct emc2103_data *data = emc2103_update_device(dev);
291 if (data->fan_tach != 0)
292 rpm = (FAN_RPM_FACTOR * data->fan_multiplier) / data->fan_tach;
293 return sprintf(buf, "%d\n", rpm);
297 show_fan_div(struct device *dev, struct device_attribute *da, char *buf)
299 struct emc2103_data *data = emc2103_update_device(dev);
300 int fan_div = 8 / data->fan_multiplier;
301 return sprintf(buf, "%d\n", fan_div);
305 * Note: we also update the fan target here, because its value is
306 * determined in part by the fan clock divider. This follows the principle
307 * of least surprise; the user doesn't expect the fan target to change just
308 * because the divider changed.
310 static ssize_t set_fan_div(struct device *dev, struct device_attribute *da,
311 const char *buf, size_t count)
313 struct emc2103_data *data = emc2103_update_device(dev);
314 struct i2c_client *client = data->client;
315 int new_range_bits, old_div = 8 / data->fan_multiplier;
318 int status = kstrtol(buf, 10, &new_div);
322 if (new_div == old_div) /* No change */
342 mutex_lock(&data->update_lock);
344 status = i2c_smbus_read_byte_data(client, REG_FAN_CONF1);
346 dev_dbg(&client->dev, "reg 0x%02x, err %d\n",
347 REG_FAN_CONF1, status);
348 mutex_unlock(&data->update_lock);
352 status |= (new_range_bits << 5);
353 i2c_smbus_write_byte_data(client, REG_FAN_CONF1, status);
355 data->fan_multiplier = 8 / new_div;
357 /* update fan target if high byte is not disabled */
358 if ((data->fan_target & 0x1fe0) != 0x1fe0) {
359 u16 new_target = (data->fan_target * old_div) / new_div;
360 data->fan_target = min(new_target, (u16)0x1fff);
361 write_fan_target_to_i2c(client, data->fan_target);
364 /* invalidate data to force re-read from hardware */
367 mutex_unlock(&data->update_lock);
372 show_fan_target(struct device *dev, struct device_attribute *da, char *buf)
374 struct emc2103_data *data = emc2103_update_device(dev);
377 /* high byte of 0xff indicates disabled so return 0 */
378 if ((data->fan_target != 0) && ((data->fan_target & 0x1fe0) != 0x1fe0))
379 rpm = (FAN_RPM_FACTOR * data->fan_multiplier)
382 return sprintf(buf, "%d\n", rpm);
385 static ssize_t set_fan_target(struct device *dev, struct device_attribute *da,
386 const char *buf, size_t count)
388 struct emc2103_data *data = emc2103_update_device(dev);
389 struct i2c_client *client = data->client;
390 unsigned long rpm_target;
392 int result = kstrtoul(buf, 10, &rpm_target);
396 /* Datasheet states 16384 as maximum RPM target (table 3.2) */
397 rpm_target = clamp_val(rpm_target, 0, 16384);
399 mutex_lock(&data->update_lock);
402 data->fan_target = 0x1fff;
404 data->fan_target = clamp_val(
405 (FAN_RPM_FACTOR * data->fan_multiplier) / rpm_target,
408 write_fan_target_to_i2c(client, data->fan_target);
410 mutex_unlock(&data->update_lock);
415 show_fan_fault(struct device *dev, struct device_attribute *da, char *buf)
417 struct emc2103_data *data = emc2103_update_device(dev);
418 bool fault = ((data->fan_tach & 0x1fe0) == 0x1fe0);
419 return sprintf(buf, "%d\n", fault ? 1 : 0);
423 show_pwm_enable(struct device *dev, struct device_attribute *da, char *buf)
425 struct emc2103_data *data = emc2103_update_device(dev);
426 return sprintf(buf, "%d\n", data->fan_rpm_control ? 3 : 0);
429 static ssize_t set_pwm_enable(struct device *dev, struct device_attribute *da,
430 const char *buf, size_t count)
432 struct emc2103_data *data = dev_get_drvdata(dev);
433 struct i2c_client *client = data->client;
437 int result = kstrtol(buf, 10, &new_value);
441 mutex_lock(&data->update_lock);
444 data->fan_rpm_control = false;
447 data->fan_rpm_control = true;
454 result = read_u8_from_i2c(client, REG_FAN_CONF1, &conf_reg);
460 if (data->fan_rpm_control)
465 i2c_smbus_write_byte_data(client, REG_FAN_CONF1, conf_reg);
467 mutex_unlock(&data->update_lock);
471 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
472 static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO | S_IWUSR, show_temp_min,
474 static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO | S_IWUSR, show_temp_max,
476 static SENSOR_DEVICE_ATTR(temp1_fault, S_IRUGO, show_temp_fault, NULL, 0);
477 static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_temp_min_alarm,
479 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_temp_max_alarm,
482 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
483 static SENSOR_DEVICE_ATTR(temp2_min, S_IRUGO | S_IWUSR, show_temp_min,
485 static SENSOR_DEVICE_ATTR(temp2_max, S_IRUGO | S_IWUSR, show_temp_max,
487 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_temp_fault, NULL, 1);
488 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_temp_min_alarm,
490 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_temp_max_alarm,
493 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
494 static SENSOR_DEVICE_ATTR(temp3_min, S_IRUGO | S_IWUSR, show_temp_min,
496 static SENSOR_DEVICE_ATTR(temp3_max, S_IRUGO | S_IWUSR, show_temp_max,
498 static SENSOR_DEVICE_ATTR(temp3_fault, S_IRUGO, show_temp_fault, NULL, 2);
499 static SENSOR_DEVICE_ATTR(temp3_min_alarm, S_IRUGO, show_temp_min_alarm,
501 static SENSOR_DEVICE_ATTR(temp3_max_alarm, S_IRUGO, show_temp_max_alarm,
504 static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp, NULL, 3);
505 static SENSOR_DEVICE_ATTR(temp4_min, S_IRUGO | S_IWUSR, show_temp_min,
507 static SENSOR_DEVICE_ATTR(temp4_max, S_IRUGO | S_IWUSR, show_temp_max,
509 static SENSOR_DEVICE_ATTR(temp4_fault, S_IRUGO, show_temp_fault, NULL, 3);
510 static SENSOR_DEVICE_ATTR(temp4_min_alarm, S_IRUGO, show_temp_min_alarm,
512 static SENSOR_DEVICE_ATTR(temp4_max_alarm, S_IRUGO, show_temp_max_alarm,
515 static DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL);
516 static DEVICE_ATTR(fan1_div, S_IRUGO | S_IWUSR, show_fan_div, set_fan_div);
517 static DEVICE_ATTR(fan1_target, S_IRUGO | S_IWUSR, show_fan_target,
519 static DEVICE_ATTR(fan1_fault, S_IRUGO, show_fan_fault, NULL);
521 static DEVICE_ATTR(pwm1_enable, S_IRUGO | S_IWUSR, show_pwm_enable,
524 /* sensors present on all models */
525 static struct attribute *emc2103_attributes[] = {
526 &sensor_dev_attr_temp1_input.dev_attr.attr,
527 &sensor_dev_attr_temp1_min.dev_attr.attr,
528 &sensor_dev_attr_temp1_max.dev_attr.attr,
529 &sensor_dev_attr_temp1_fault.dev_attr.attr,
530 &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
531 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
532 &sensor_dev_attr_temp2_input.dev_attr.attr,
533 &sensor_dev_attr_temp2_min.dev_attr.attr,
534 &sensor_dev_attr_temp2_max.dev_attr.attr,
535 &sensor_dev_attr_temp2_fault.dev_attr.attr,
536 &sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
537 &sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
538 &dev_attr_fan1_input.attr,
539 &dev_attr_fan1_div.attr,
540 &dev_attr_fan1_target.attr,
541 &dev_attr_fan1_fault.attr,
542 &dev_attr_pwm1_enable.attr,
546 /* extra temperature sensors only present on 2103-2 and 2103-4 */
547 static struct attribute *emc2103_attributes_temp3[] = {
548 &sensor_dev_attr_temp3_input.dev_attr.attr,
549 &sensor_dev_attr_temp3_min.dev_attr.attr,
550 &sensor_dev_attr_temp3_max.dev_attr.attr,
551 &sensor_dev_attr_temp3_fault.dev_attr.attr,
552 &sensor_dev_attr_temp3_min_alarm.dev_attr.attr,
553 &sensor_dev_attr_temp3_max_alarm.dev_attr.attr,
557 /* extra temperature sensors only present on 2103-2 and 2103-4 in APD mode */
558 static struct attribute *emc2103_attributes_temp4[] = {
559 &sensor_dev_attr_temp4_input.dev_attr.attr,
560 &sensor_dev_attr_temp4_min.dev_attr.attr,
561 &sensor_dev_attr_temp4_max.dev_attr.attr,
562 &sensor_dev_attr_temp4_fault.dev_attr.attr,
563 &sensor_dev_attr_temp4_min_alarm.dev_attr.attr,
564 &sensor_dev_attr_temp4_max_alarm.dev_attr.attr,
568 static const struct attribute_group emc2103_group = {
569 .attrs = emc2103_attributes,
572 static const struct attribute_group emc2103_temp3_group = {
573 .attrs = emc2103_attributes_temp3,
576 static const struct attribute_group emc2103_temp4_group = {
577 .attrs = emc2103_attributes_temp4,
581 emc2103_probe(struct i2c_client *client, const struct i2c_device_id *id)
583 struct emc2103_data *data;
584 struct device *hwmon_dev;
587 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
590 data = devm_kzalloc(&client->dev, sizeof(struct emc2103_data),
595 i2c_set_clientdata(client, data);
596 data->client = client;
597 mutex_init(&data->update_lock);
599 /* 2103-2 and 2103-4 have 3 external diodes, 2103-1 has 1 */
600 status = i2c_smbus_read_byte_data(client, REG_PRODUCT_ID);
601 if (status == 0x24) {
602 /* 2103-1 only has 1 external diode */
603 data->temp_count = 2;
605 /* 2103-2 and 2103-4 have 3 or 4 external diodes */
606 status = i2c_smbus_read_byte_data(client, REG_CONF1);
608 dev_dbg(&client->dev, "reg 0x%02x, err %d\n", REG_CONF1,
613 /* detect current state of hardware */
614 data->temp_count = (status & 0x01) ? 4 : 3;
616 /* force APD state if module parameter is set */
618 /* force APD mode off */
619 data->temp_count = 3;
621 i2c_smbus_write_byte_data(client, REG_CONF1, status);
622 } else if (apd == 1) {
623 /* force APD mode on */
624 data->temp_count = 4;
626 i2c_smbus_write_byte_data(client, REG_CONF1, status);
631 data->groups[idx++] = &emc2103_group;
632 if (data->temp_count >= 3)
633 data->groups[idx++] = &emc2103_temp3_group;
634 if (data->temp_count == 4)
635 data->groups[idx++] = &emc2103_temp4_group;
637 hwmon_dev = devm_hwmon_device_register_with_groups(&client->dev,
640 if (IS_ERR(hwmon_dev))
641 return PTR_ERR(hwmon_dev);
643 dev_info(&client->dev, "%s: sensor '%s'\n",
644 dev_name(hwmon_dev), client->name);
649 static const struct i2c_device_id emc2103_ids[] = {
653 MODULE_DEVICE_TABLE(i2c, emc2103_ids);
655 /* Return 0 if detection is successful, -ENODEV otherwise */
657 emc2103_detect(struct i2c_client *new_client, struct i2c_board_info *info)
659 struct i2c_adapter *adapter = new_client->adapter;
660 int manufacturer, product;
662 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
665 manufacturer = i2c_smbus_read_byte_data(new_client, REG_MFG_ID);
666 if (manufacturer != 0x5D)
669 product = i2c_smbus_read_byte_data(new_client, REG_PRODUCT_ID);
670 if ((product != 0x24) && (product != 0x26))
673 strlcpy(info->type, "emc2103", I2C_NAME_SIZE);
678 static struct i2c_driver emc2103_driver = {
679 .class = I2C_CLASS_HWMON,
683 .probe = emc2103_probe,
684 .id_table = emc2103_ids,
685 .detect = emc2103_detect,
686 .address_list = normal_i2c,
689 module_i2c_driver(emc2103_driver);
691 MODULE_AUTHOR("Steve Glendinning <steve.glendinning@shawell.net>");
692 MODULE_DESCRIPTION("SMSC EMC2103 hwmon driver");
693 MODULE_LICENSE("GPL");