2 * max6650.c - Part of lm_sensors, Linux kernel modules for hardware
5 * (C) 2007 by Hans J. Koch <hjk@linutronix.de>
7 * based on code written by John Morris <john.morris@spirentcom.com>
8 * Copyright (c) 2003 Spirent Communications
9 * and Claus Gindhart <claus.gindhart@kontron.com>
11 * This module has only been tested with the MAX6650 chip. It should
12 * also work with the MAX6651. It does not distinguish max6650 and max6651
15 * The datasheet was last seen at:
17 * http://pdfserv.maxim-ic.com/en/ds/MAX6650-MAX6651.pdf
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
34 #include <linux/module.h>
35 #include <linux/init.h>
36 #include <linux/slab.h>
37 #include <linux/jiffies.h>
38 #include <linux/i2c.h>
39 #include <linux/hwmon.h>
40 #include <linux/hwmon-sysfs.h>
41 #include <linux/err.h>
44 * Addresses to scan. There are four disjoint possibilities, by pin config.
47 static const unsigned short normal_i2c[] = {0x1b, 0x1f, 0x48, 0x4b,
54 /* fan_voltage: 5=5V fan, 12=12V fan, 0=don't change */
55 static int fan_voltage;
56 /* prescaler: Possible values are 1, 2, 4, 8, 16 or 0 for don't change */
58 /* clock: The clock frequency of the chip the driver should assume */
59 static int clock = 254000;
61 module_param(fan_voltage, int, S_IRUGO);
62 module_param(prescaler, int, S_IRUGO);
63 module_param(clock, int, S_IRUGO);
65 I2C_CLIENT_INSMOD_1(max6650);
68 * MAX 6650/6651 registers
71 #define MAX6650_REG_SPEED 0x00
72 #define MAX6650_REG_CONFIG 0x02
73 #define MAX6650_REG_GPIO_DEF 0x04
74 #define MAX6650_REG_DAC 0x06
75 #define MAX6650_REG_ALARM_EN 0x08
76 #define MAX6650_REG_ALARM 0x0A
77 #define MAX6650_REG_TACH0 0x0C
78 #define MAX6650_REG_TACH1 0x0E
79 #define MAX6650_REG_TACH2 0x10
80 #define MAX6650_REG_TACH3 0x12
81 #define MAX6650_REG_GPIO_STAT 0x14
82 #define MAX6650_REG_COUNT 0x16
85 * Config register bits
88 #define MAX6650_CFG_V12 0x08
89 #define MAX6650_CFG_PRESCALER_MASK 0x07
90 #define MAX6650_CFG_PRESCALER_2 0x01
91 #define MAX6650_CFG_PRESCALER_4 0x02
92 #define MAX6650_CFG_PRESCALER_8 0x03
93 #define MAX6650_CFG_PRESCALER_16 0x04
94 #define MAX6650_CFG_MODE_MASK 0x30
95 #define MAX6650_CFG_MODE_ON 0x00
96 #define MAX6650_CFG_MODE_OFF 0x10
97 #define MAX6650_CFG_MODE_CLOSED_LOOP 0x20
98 #define MAX6650_CFG_MODE_OPEN_LOOP 0x30
99 #define MAX6650_COUNT_MASK 0x03
102 * Alarm status register bits
105 #define MAX6650_ALRM_MAX 0x01
106 #define MAX6650_ALRM_MIN 0x02
107 #define MAX6650_ALRM_TACH 0x04
108 #define MAX6650_ALRM_GPIO1 0x08
109 #define MAX6650_ALRM_GPIO2 0x10
111 /* Minimum and maximum values of the FAN-RPM */
112 #define FAN_RPM_MIN 240
113 #define FAN_RPM_MAX 30000
115 #define DIV_FROM_REG(reg) (1 << (reg & 7))
117 static int max6650_probe(struct i2c_client *client,
118 const struct i2c_device_id *id);
119 static int max6650_detect(struct i2c_client *client, int kind,
120 struct i2c_board_info *info);
121 static int max6650_init_client(struct i2c_client *client);
122 static int max6650_remove(struct i2c_client *client);
123 static struct max6650_data *max6650_update_device(struct device *dev);
126 * Driver data (common to all clients)
129 static const struct i2c_device_id max6650_id[] = {
130 { "max6650", max6650 },
133 MODULE_DEVICE_TABLE(i2c, max6650_id);
135 static struct i2c_driver max6650_driver = {
136 .class = I2C_CLASS_HWMON,
140 .probe = max6650_probe,
141 .remove = max6650_remove,
142 .id_table = max6650_id,
143 .detect = max6650_detect,
144 .address_data = &addr_data,
148 * Client data (each client gets its own)
153 struct device *hwmon_dev;
154 struct mutex update_lock;
155 char valid; /* zero until following fields are valid */
156 unsigned long last_updated; /* in jiffies */
158 /* register values */
167 static ssize_t get_fan(struct device *dev, struct device_attribute *devattr,
170 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
171 struct max6650_data *data = max6650_update_device(dev);
175 * Calculation details:
177 * Each tachometer counts over an interval given by the "count"
178 * register (0.25, 0.5, 1 or 2 seconds). This module assumes
179 * that the fans produce two pulses per revolution (this seems
180 * to be the most common).
183 rpm = ((data->tach[attr->index] * 120) / DIV_FROM_REG(data->count));
184 return sprintf(buf, "%d\n", rpm);
188 * Set the fan speed to the specified RPM (or read back the RPM setting).
189 * This works in closed loop mode only. Use pwm1 for open loop speed setting.
191 * The MAX6650/1 will automatically control fan speed when in closed loop
196 * 1) The MAX6650/1 internal 254kHz clock frequency is set correctly. Use
197 * the clock module parameter if you need to fine tune this.
199 * 2) The prescaler (low three bits of the config register) has already
200 * been set to an appropriate value. Use the prescaler module parameter
201 * if your BIOS doesn't initialize the chip properly.
203 * The relevant equations are given on pages 21 and 22 of the datasheet.
205 * From the datasheet, the relevant equation when in regulation is:
207 * [fCLK / (128 x (KTACH + 1))] = 2 x FanSpeed / KSCALE
211 * fCLK is the oscillator frequency (either the 254kHz internal
212 * oscillator or the externally applied clock)
214 * KTACH is the value in the speed register
216 * FanSpeed is the speed of the fan in rps
218 * KSCALE is the prescaler value (1, 2, 4, 8, or 16)
220 * When reading, we need to solve for FanSpeed. When writing, we need to
223 * Note: this tachometer is completely separate from the tachometers
224 * used to measure the fan speeds. Only one fan's speed (fan1) is
228 static ssize_t get_target(struct device *dev, struct device_attribute *devattr,
231 struct max6650_data *data = max6650_update_device(dev);
232 int kscale, ktach, rpm;
235 * Use the datasheet equation:
237 * FanSpeed = KSCALE x fCLK / [256 x (KTACH + 1)]
239 * then multiply by 60 to give rpm.
242 kscale = DIV_FROM_REG(data->config);
244 rpm = 60 * kscale * clock / (256 * (ktach + 1));
245 return sprintf(buf, "%d\n", rpm);
248 static ssize_t set_target(struct device *dev, struct device_attribute *devattr,
249 const char *buf, size_t count)
251 struct i2c_client *client = to_i2c_client(dev);
252 struct max6650_data *data = i2c_get_clientdata(client);
253 int rpm = simple_strtoul(buf, NULL, 10);
256 rpm = SENSORS_LIMIT(rpm, FAN_RPM_MIN, FAN_RPM_MAX);
259 * Divide the required speed by 60 to get from rpm to rps, then
260 * use the datasheet equation:
262 * KTACH = [(fCLK x KSCALE) / (256 x FanSpeed)] - 1
265 mutex_lock(&data->update_lock);
267 kscale = DIV_FROM_REG(data->config);
268 ktach = ((clock * kscale) / (256 * rpm / 60)) - 1;
275 i2c_smbus_write_byte_data(client, MAX6650_REG_SPEED, data->speed);
277 mutex_unlock(&data->update_lock);
283 * Get/set the fan speed in open loop mode using pwm1 sysfs file.
284 * Speed is given as a relative value from 0 to 255, where 255 is maximum
285 * speed. Note that this is done by writing directly to the chip's DAC,
286 * it won't change the closed loop speed set by fan1_target.
287 * Also note that due to rounding errors it is possible that you don't read
288 * back exactly the value you have set.
291 static ssize_t get_pwm(struct device *dev, struct device_attribute *devattr,
295 struct max6650_data *data = max6650_update_device(dev);
297 /* Useful range for dac is 0-180 for 12V fans and 0-76 for 5V fans.
298 Lower DAC values mean higher speeds. */
299 if (data->config & MAX6650_CFG_V12)
300 pwm = 255 - (255 * (int)data->dac)/180;
302 pwm = 255 - (255 * (int)data->dac)/76;
307 return sprintf(buf, "%d\n", pwm);
310 static ssize_t set_pwm(struct device *dev, struct device_attribute *devattr,
311 const char *buf, size_t count)
313 struct i2c_client *client = to_i2c_client(dev);
314 struct max6650_data *data = i2c_get_clientdata(client);
315 int pwm = simple_strtoul(buf, NULL, 10);
317 pwm = SENSORS_LIMIT(pwm, 0, 255);
319 mutex_lock(&data->update_lock);
321 if (data->config & MAX6650_CFG_V12)
322 data->dac = 180 - (180 * pwm)/255;
324 data->dac = 76 - (76 * pwm)/255;
326 i2c_smbus_write_byte_data(client, MAX6650_REG_DAC, data->dac);
328 mutex_unlock(&data->update_lock);
334 * Get/Set controller mode:
337 * 1 = Open loop, Voltage is set according to speed, not regulated.
338 * 2 = Closed loop, RPM for all fans regulated by fan1 tachometer
341 static ssize_t get_enable(struct device *dev, struct device_attribute *devattr,
344 struct max6650_data *data = max6650_update_device(dev);
345 int mode = (data->config & MAX6650_CFG_MODE_MASK) >> 4;
346 int sysfs_modes[4] = {0, 1, 2, 1};
348 return sprintf(buf, "%d\n", sysfs_modes[mode]);
351 static ssize_t set_enable(struct device *dev, struct device_attribute *devattr,
352 const char *buf, size_t count)
354 struct i2c_client *client = to_i2c_client(dev);
355 struct max6650_data *data = i2c_get_clientdata(client);
356 int mode = simple_strtoul(buf, NULL, 10);
357 int max6650_modes[3] = {0, 3, 2};
359 if ((mode < 0)||(mode > 2)) {
360 dev_err(&client->dev,
361 "illegal value for pwm1_enable (%d)\n", mode);
365 mutex_lock(&data->update_lock);
367 data->config = i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG);
368 data->config = (data->config & ~MAX6650_CFG_MODE_MASK)
369 | (max6650_modes[mode] << 4);
371 i2c_smbus_write_byte_data(client, MAX6650_REG_CONFIG, data->config);
373 mutex_unlock(&data->update_lock);
379 * Read/write functions for fan1_div sysfs file. The MAX6650 has no such
380 * divider. We handle this by converting between divider and counttime:
382 * (counttime == k) <==> (divider == 2^k), k = 0, 1, 2, or 3
384 * Lower values of k allow to connect a faster fan without the risk of
385 * counter overflow. The price is lower resolution. You can also set counttime
386 * using the module parameter. Note that the module parameter "prescaler" also
387 * influences the behaviour. Unfortunately, there's no sysfs attribute
388 * defined for that. See the data sheet for details.
391 static ssize_t get_div(struct device *dev, struct device_attribute *devattr,
394 struct max6650_data *data = max6650_update_device(dev);
396 return sprintf(buf, "%d\n", DIV_FROM_REG(data->count));
399 static ssize_t set_div(struct device *dev, struct device_attribute *devattr,
400 const char *buf, size_t count)
402 struct i2c_client *client = to_i2c_client(dev);
403 struct max6650_data *data = i2c_get_clientdata(client);
404 int div = simple_strtoul(buf, NULL, 10);
406 mutex_lock(&data->update_lock);
421 dev_err(&client->dev,
422 "illegal value for fan divider (%d)\n", div);
426 i2c_smbus_write_byte_data(client, MAX6650_REG_COUNT, data->count);
427 mutex_unlock(&data->update_lock);
439 static ssize_t get_alarm(struct device *dev, struct device_attribute *devattr,
442 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
443 struct max6650_data *data = max6650_update_device(dev);
444 struct i2c_client *client = to_i2c_client(dev);
447 if (data->alarm & attr->index) {
448 mutex_lock(&data->update_lock);
450 data->alarm &= ~attr->index;
451 data->alarm |= i2c_smbus_read_byte_data(client,
453 mutex_unlock(&data->update_lock);
456 return sprintf(buf, "%d\n", alarm);
459 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, get_fan, NULL, 0);
460 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, get_fan, NULL, 1);
461 static SENSOR_DEVICE_ATTR(fan3_input, S_IRUGO, get_fan, NULL, 2);
462 static SENSOR_DEVICE_ATTR(fan4_input, S_IRUGO, get_fan, NULL, 3);
463 static DEVICE_ATTR(fan1_target, S_IWUSR | S_IRUGO, get_target, set_target);
464 static DEVICE_ATTR(fan1_div, S_IWUSR | S_IRUGO, get_div, set_div);
465 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO, get_enable, set_enable);
466 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, get_pwm, set_pwm);
467 static SENSOR_DEVICE_ATTR(fan1_max_alarm, S_IRUGO, get_alarm, NULL,
469 static SENSOR_DEVICE_ATTR(fan1_min_alarm, S_IRUGO, get_alarm, NULL,
471 static SENSOR_DEVICE_ATTR(fan1_fault, S_IRUGO, get_alarm, NULL,
473 static SENSOR_DEVICE_ATTR(gpio1_alarm, S_IRUGO, get_alarm, NULL,
475 static SENSOR_DEVICE_ATTR(gpio2_alarm, S_IRUGO, get_alarm, NULL,
478 static mode_t max6650_attrs_visible(struct kobject *kobj, struct attribute *a,
481 struct device *dev = container_of(kobj, struct device, kobj);
482 struct i2c_client *client = to_i2c_client(dev);
483 u8 alarm_en = i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM_EN);
484 struct device_attribute *devattr;
487 * Hide the alarms that have not been enabled by the firmware
490 devattr = container_of(a, struct device_attribute, attr);
491 if (devattr == &sensor_dev_attr_fan1_max_alarm.dev_attr
492 || devattr == &sensor_dev_attr_fan1_min_alarm.dev_attr
493 || devattr == &sensor_dev_attr_fan1_fault.dev_attr
494 || devattr == &sensor_dev_attr_gpio1_alarm.dev_attr
495 || devattr == &sensor_dev_attr_gpio2_alarm.dev_attr) {
496 if (!(alarm_en & to_sensor_dev_attr(devattr)->index))
503 static struct attribute *max6650_attrs[] = {
504 &sensor_dev_attr_fan1_input.dev_attr.attr,
505 &sensor_dev_attr_fan2_input.dev_attr.attr,
506 &sensor_dev_attr_fan3_input.dev_attr.attr,
507 &sensor_dev_attr_fan4_input.dev_attr.attr,
508 &dev_attr_fan1_target.attr,
509 &dev_attr_fan1_div.attr,
510 &dev_attr_pwm1_enable.attr,
512 &sensor_dev_attr_fan1_max_alarm.dev_attr.attr,
513 &sensor_dev_attr_fan1_min_alarm.dev_attr.attr,
514 &sensor_dev_attr_fan1_fault.dev_attr.attr,
515 &sensor_dev_attr_gpio1_alarm.dev_attr.attr,
516 &sensor_dev_attr_gpio2_alarm.dev_attr.attr,
520 static struct attribute_group max6650_attr_grp = {
521 .attrs = max6650_attrs,
522 .is_visible = max6650_attrs_visible,
529 /* Return 0 if detection is successful, -ENODEV otherwise */
530 static int max6650_detect(struct i2c_client *client, int kind,
531 struct i2c_board_info *info)
533 struct i2c_adapter *adapter = client->adapter;
534 int address = client->addr;
536 dev_dbg(&adapter->dev, "max6650_detect called, kind = %d\n", kind);
538 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
539 dev_dbg(&adapter->dev, "max6650: I2C bus doesn't support "
540 "byte read mode, skipping.\n");
545 * Now we do the remaining detection. A negative kind means that
546 * the driver was loaded with no force parameter (default), so we
547 * must both detect and identify the chip (actually there is only
548 * one possible kind of chip for now, max6650). A zero kind means that
549 * the driver was loaded with the force parameter, the detection
550 * step shall be skipped. A positive kind means that the driver
551 * was loaded with the force parameter and a given kind of chip is
552 * requested, so both the detection and the identification steps
555 * Currently I can find no way to distinguish between a MAX6650 and
556 * a MAX6651. This driver has only been tried on the former.
560 ( (i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG) & 0xC0)
561 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_GPIO_STAT) & 0xE0)
562 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM_EN) & 0xE0)
563 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM) & 0xE0)
564 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_COUNT) & 0xFC))) {
565 dev_dbg(&adapter->dev,
566 "max6650: detection failed at 0x%02x.\n", address);
570 dev_info(&adapter->dev, "max6650: chip found at 0x%02x.\n", address);
572 strlcpy(info->type, "max6650", I2C_NAME_SIZE);
577 static int max6650_probe(struct i2c_client *client,
578 const struct i2c_device_id *id)
580 struct max6650_data *data;
583 if (!(data = kzalloc(sizeof(struct max6650_data), GFP_KERNEL))) {
584 dev_err(&client->dev, "out of memory.\n");
588 i2c_set_clientdata(client, data);
589 mutex_init(&data->update_lock);
592 * Initialize the max6650 chip
594 err = max6650_init_client(client);
598 err = sysfs_create_group(&client->dev.kobj, &max6650_attr_grp);
602 data->hwmon_dev = hwmon_device_register(&client->dev);
603 if (!IS_ERR(data->hwmon_dev))
606 err = PTR_ERR(data->hwmon_dev);
607 dev_err(&client->dev, "error registering hwmon device.\n");
608 sysfs_remove_group(&client->dev.kobj, &max6650_attr_grp);
614 static int max6650_remove(struct i2c_client *client)
616 struct max6650_data *data = i2c_get_clientdata(client);
618 sysfs_remove_group(&client->dev.kobj, &max6650_attr_grp);
619 hwmon_device_unregister(data->hwmon_dev);
624 static int max6650_init_client(struct i2c_client *client)
626 struct max6650_data *data = i2c_get_clientdata(client);
630 config = i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG);
633 dev_err(&client->dev, "Error reading config, aborting.\n");
637 switch (fan_voltage) {
641 config &= ~MAX6650_CFG_V12;
644 config |= MAX6650_CFG_V12;
647 dev_err(&client->dev,
648 "illegal value for fan_voltage (%d)\n",
652 dev_info(&client->dev, "Fan voltage is set to %dV.\n",
653 (config & MAX6650_CFG_V12) ? 12 : 5);
659 config &= ~MAX6650_CFG_PRESCALER_MASK;
662 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
663 | MAX6650_CFG_PRESCALER_2;
666 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
667 | MAX6650_CFG_PRESCALER_4;
670 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
671 | MAX6650_CFG_PRESCALER_8;
674 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
675 | MAX6650_CFG_PRESCALER_16;
678 dev_err(&client->dev,
679 "illegal value for prescaler (%d)\n",
683 dev_info(&client->dev, "Prescaler is set to %d.\n",
684 1 << (config & MAX6650_CFG_PRESCALER_MASK));
686 /* If mode is set to "full off", we change it to "open loop" and
687 * set DAC to 255, which has the same effect. We do this because
688 * there's no "full off" mode defined in hwmon specifcations.
691 if ((config & MAX6650_CFG_MODE_MASK) == MAX6650_CFG_MODE_OFF) {
692 dev_dbg(&client->dev, "Change mode to open loop, full off.\n");
693 config = (config & ~MAX6650_CFG_MODE_MASK)
694 | MAX6650_CFG_MODE_OPEN_LOOP;
695 if (i2c_smbus_write_byte_data(client, MAX6650_REG_DAC, 255)) {
696 dev_err(&client->dev, "DAC write error, aborting.\n");
701 if (i2c_smbus_write_byte_data(client, MAX6650_REG_CONFIG, config)) {
702 dev_err(&client->dev, "Config write error, aborting.\n");
706 data->config = config;
707 data->count = i2c_smbus_read_byte_data(client, MAX6650_REG_COUNT);
712 static const u8 tach_reg[] = {
719 static struct max6650_data *max6650_update_device(struct device *dev)
722 struct i2c_client *client = to_i2c_client(dev);
723 struct max6650_data *data = i2c_get_clientdata(client);
725 mutex_lock(&data->update_lock);
727 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
728 data->speed = i2c_smbus_read_byte_data(client,
730 data->config = i2c_smbus_read_byte_data(client,
732 for (i = 0; i < 4; i++) {
733 data->tach[i] = i2c_smbus_read_byte_data(client,
736 data->count = i2c_smbus_read_byte_data(client,
738 data->dac = i2c_smbus_read_byte_data(client, MAX6650_REG_DAC);
740 /* Alarms are cleared on read in case the condition that
741 * caused the alarm is removed. Keep the value latched here
742 * for providing the register through different alarm files. */
743 data->alarm |= i2c_smbus_read_byte_data(client,
746 data->last_updated = jiffies;
750 mutex_unlock(&data->update_lock);
755 static int __init sensors_max6650_init(void)
757 return i2c_add_driver(&max6650_driver);
760 static void __exit sensors_max6650_exit(void)
762 i2c_del_driver(&max6650_driver);
765 MODULE_AUTHOR("Hans J. Koch");
766 MODULE_DESCRIPTION("MAX6650 sensor driver");
767 MODULE_LICENSE("GPL");
769 module_init(sensors_max6650_init);
770 module_exit(sensors_max6650_exit);