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 * Tha 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
101 /* Minimum and maximum values of the FAN-RPM */
102 #define FAN_RPM_MIN 240
103 #define FAN_RPM_MAX 30000
105 #define DIV_FROM_REG(reg) (1 << (reg & 7))
107 static int max6650_attach_adapter(struct i2c_adapter *adapter);
108 static int max6650_detect(struct i2c_adapter *adapter, int address, int kind);
109 static int max6650_init_client(struct i2c_client *client);
110 static int max6650_detach_client(struct i2c_client *client);
111 static struct max6650_data *max6650_update_device(struct device *dev);
114 * Driver data (common to all clients)
117 static struct i2c_driver max6650_driver = {
121 .attach_adapter = max6650_attach_adapter,
122 .detach_client = max6650_detach_client,
126 * Client data (each client gets its own)
131 struct i2c_client client;
132 struct device *hwmon_dev;
133 struct mutex update_lock;
134 char valid; /* zero until following fields are valid */
135 unsigned long last_updated; /* in jiffies */
137 /* register values */
145 static ssize_t get_fan(struct device *dev, struct device_attribute *devattr,
148 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
149 struct max6650_data *data = max6650_update_device(dev);
153 * Calculation details:
155 * Each tachometer counts over an interval given by the "count"
156 * register (0.25, 0.5, 1 or 2 seconds). This module assumes
157 * that the fans produce two pulses per revolution (this seems
158 * to be the most common).
161 rpm = ((data->tach[attr->index] * 120) / DIV_FROM_REG(data->count));
162 return sprintf(buf, "%d\n", rpm);
166 * Set the fan speed to the specified RPM (or read back the RPM setting).
167 * This works in closed loop mode only. Use pwm1 for open loop speed setting.
169 * The MAX6650/1 will automatically control fan speed when in closed loop
174 * 1) The MAX6650/1 internal 254kHz clock frequency is set correctly. Use
175 * the clock module parameter if you need to fine tune this.
177 * 2) The prescaler (low three bits of the config register) has already
178 * been set to an appropriate value. Use the prescaler module parameter
179 * if your BIOS doesn't initialize the chip properly.
181 * The relevant equations are given on pages 21 and 22 of the datasheet.
183 * From the datasheet, the relevant equation when in regulation is:
185 * [fCLK / (128 x (KTACH + 1))] = 2 x FanSpeed / KSCALE
189 * fCLK is the oscillator frequency (either the 254kHz internal
190 * oscillator or the externally applied clock)
192 * KTACH is the value in the speed register
194 * FanSpeed is the speed of the fan in rps
196 * KSCALE is the prescaler value (1, 2, 4, 8, or 16)
198 * When reading, we need to solve for FanSpeed. When writing, we need to
201 * Note: this tachometer is completely separate from the tachometers
202 * used to measure the fan speeds. Only one fan's speed (fan1) is
206 static ssize_t get_target(struct device *dev, struct device_attribute *devattr,
209 struct max6650_data *data = max6650_update_device(dev);
210 int kscale, ktach, rpm;
213 * Use the datasheet equation:
215 * FanSpeed = KSCALE x fCLK / [256 x (KTACH + 1)]
217 * then multiply by 60 to give rpm.
220 kscale = DIV_FROM_REG(data->config);
222 rpm = 60 * kscale * clock / (256 * (ktach + 1));
223 return sprintf(buf, "%d\n", rpm);
226 static ssize_t set_target(struct device *dev, struct device_attribute *devattr,
227 const char *buf, size_t count)
229 struct i2c_client *client = to_i2c_client(dev);
230 struct max6650_data *data = i2c_get_clientdata(client);
231 int rpm = simple_strtoul(buf, NULL, 10);
234 rpm = SENSORS_LIMIT(rpm, FAN_RPM_MIN, FAN_RPM_MAX);
237 * Divide the required speed by 60 to get from rpm to rps, then
238 * use the datasheet equation:
240 * KTACH = [(fCLK x KSCALE) / (256 x FanSpeed)] - 1
243 mutex_lock(&data->update_lock);
245 kscale = DIV_FROM_REG(data->config);
246 ktach = ((clock * kscale) / (256 * rpm / 60)) - 1;
253 i2c_smbus_write_byte_data(client, MAX6650_REG_SPEED, data->speed);
255 mutex_unlock(&data->update_lock);
261 * Get/set the fan speed in open loop mode using pwm1 sysfs file.
262 * Speed is given as a relative value from 0 to 255, where 255 is maximum
263 * speed. Note that this is done by writing directly to the chip's DAC,
264 * it won't change the closed loop speed set by fan1_target.
265 * Also note that due to rounding errors it is possible that you don't read
266 * back exactly the value you have set.
269 static ssize_t get_pwm(struct device *dev, struct device_attribute *devattr,
273 struct max6650_data *data = max6650_update_device(dev);
275 /* Useful range for dac is 0-180 for 12V fans and 0-76 for 5V fans.
276 Lower DAC values mean higher speeds. */
277 if (data->config & MAX6650_CFG_V12)
278 pwm = 255 - (255 * (int)data->dac)/180;
280 pwm = 255 - (255 * (int)data->dac)/76;
285 return sprintf(buf, "%d\n", pwm);
288 static ssize_t set_pwm(struct device *dev, struct device_attribute *devattr,
289 const char *buf, size_t count)
291 struct i2c_client *client = to_i2c_client(dev);
292 struct max6650_data *data = i2c_get_clientdata(client);
293 int pwm = simple_strtoul(buf, NULL, 10);
295 pwm = SENSORS_LIMIT(pwm, 0, 255);
297 mutex_lock(&data->update_lock);
299 if (data->config & MAX6650_CFG_V12)
300 data->dac = 180 - (180 * pwm)/255;
302 data->dac = 76 - (76 * pwm)/255;
304 i2c_smbus_write_byte_data(client, MAX6650_REG_DAC, data->dac);
306 mutex_unlock(&data->update_lock);
312 * Get/Set controller mode:
315 * 1 = Open loop, Voltage is set according to speed, not regulated.
316 * 2 = Closed loop, RPM for all fans regulated by fan1 tachometer
319 static ssize_t get_enable(struct device *dev, struct device_attribute *devattr,
322 struct max6650_data *data = max6650_update_device(dev);
323 int mode = (data->config & MAX6650_CFG_MODE_MASK) >> 4;
324 int sysfs_modes[4] = {0, 1, 2, 1};
326 return sprintf(buf, "%d\n", sysfs_modes[mode]);
329 static ssize_t set_enable(struct device *dev, struct device_attribute *devattr,
330 const char *buf, size_t count)
332 struct i2c_client *client = to_i2c_client(dev);
333 struct max6650_data *data = i2c_get_clientdata(client);
334 int mode = simple_strtoul(buf, NULL, 10);
335 int max6650_modes[3] = {0, 3, 2};
337 if ((mode < 0)||(mode > 2)) {
338 dev_err(&client->dev,
339 "illegal value for pwm1_enable (%d)\n", mode);
343 mutex_lock(&data->update_lock);
345 data->config = i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG);
346 data->config = (data->config & ~MAX6650_CFG_MODE_MASK)
347 | (max6650_modes[mode] << 4);
349 i2c_smbus_write_byte_data(client, MAX6650_REG_CONFIG, data->config);
351 mutex_unlock(&data->update_lock);
357 * Read/write functions for fan1_div sysfs file. The MAX6650 has no such
358 * divider. We handle this by converting between divider and counttime:
360 * (counttime == k) <==> (divider == 2^k), k = 0, 1, 2, or 3
362 * Lower values of k allow to connect a faster fan without the risk of
363 * counter overflow. The price is lower resolution. You can also set counttime
364 * using the module parameter. Note that the module parameter "prescaler" also
365 * influences the behaviour. Unfortunately, there's no sysfs attribute
366 * defined for that. See the data sheet for details.
369 static ssize_t get_div(struct device *dev, struct device_attribute *devattr,
372 struct max6650_data *data = max6650_update_device(dev);
374 return sprintf(buf, "%d\n", DIV_FROM_REG(data->count));
377 static ssize_t set_div(struct device *dev, struct device_attribute *devattr,
378 const char *buf, size_t count)
380 struct i2c_client *client = to_i2c_client(dev);
381 struct max6650_data *data = i2c_get_clientdata(client);
382 int div = simple_strtoul(buf, NULL, 10);
384 mutex_lock(&data->update_lock);
399 dev_err(&client->dev,
400 "illegal value for fan divider (%d)\n", div);
404 i2c_smbus_write_byte_data(client, MAX6650_REG_COUNT, data->count);
405 mutex_unlock(&data->update_lock);
410 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, get_fan, NULL, 0);
411 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, get_fan, NULL, 1);
412 static SENSOR_DEVICE_ATTR(fan3_input, S_IRUGO, get_fan, NULL, 2);
413 static SENSOR_DEVICE_ATTR(fan4_input, S_IRUGO, get_fan, NULL, 3);
414 static DEVICE_ATTR(fan1_target, S_IWUSR | S_IRUGO, get_target, set_target);
415 static DEVICE_ATTR(fan1_div, S_IWUSR | S_IRUGO, get_div, set_div);
416 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO, get_enable, set_enable);
417 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, get_pwm, set_pwm);
420 static struct attribute *max6650_attrs[] = {
421 &sensor_dev_attr_fan1_input.dev_attr.attr,
422 &sensor_dev_attr_fan2_input.dev_attr.attr,
423 &sensor_dev_attr_fan3_input.dev_attr.attr,
424 &sensor_dev_attr_fan4_input.dev_attr.attr,
425 &dev_attr_fan1_target.attr,
426 &dev_attr_fan1_div.attr,
427 &dev_attr_pwm1_enable.attr,
432 static struct attribute_group max6650_attr_grp = {
433 .attrs = max6650_attrs,
440 static int max6650_attach_adapter(struct i2c_adapter *adapter)
442 if (!(adapter->class & I2C_CLASS_HWMON)) {
443 dev_dbg(&adapter->dev,
444 "FATAL: max6650_attach_adapter class HWMON not set\n");
448 return i2c_probe(adapter, &addr_data, max6650_detect);
452 * The following function does more than just detection. If detection
453 * succeeds, it also registers the new chip.
456 static int max6650_detect(struct i2c_adapter *adapter, int address, int kind)
458 struct i2c_client *client;
459 struct max6650_data *data;
462 dev_dbg(&adapter->dev, "max6650_detect called, kind = %d\n", kind);
464 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
465 dev_dbg(&adapter->dev, "max6650: I2C bus doesn't support "
466 "byte read mode, skipping.\n");
470 if (!(data = kzalloc(sizeof(struct max6650_data), GFP_KERNEL))) {
471 dev_err(&adapter->dev, "max6650: out of memory.\n");
475 client = &data->client;
476 i2c_set_clientdata(client, data);
477 client->addr = address;
478 client->adapter = adapter;
479 client->driver = &max6650_driver;
482 * Now we do the remaining detection. A negative kind means that
483 * the driver was loaded with no force parameter (default), so we
484 * must both detect and identify the chip (actually there is only
485 * one possible kind of chip for now, max6650). A zero kind means that
486 * the driver was loaded with the force parameter, the detection
487 * step shall be skipped. A positive kind means that the driver
488 * was loaded with the force parameter and a given kind of chip is
489 * requested, so both the detection and the identification steps
492 * Currently I can find no way to distinguish between a MAX6650 and
493 * a MAX6651. This driver has only been tried on the former.
497 ( (i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG) & 0xC0)
498 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_GPIO_STAT) & 0xE0)
499 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM_EN) & 0xE0)
500 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM) & 0xE0)
501 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_COUNT) & 0xFC))) {
502 dev_dbg(&adapter->dev,
503 "max6650: detection failed at 0x%02x.\n", address);
507 dev_info(&adapter->dev, "max6650: chip found at 0x%02x.\n", address);
509 strlcpy(client->name, "max6650", I2C_NAME_SIZE);
510 mutex_init(&data->update_lock);
512 if ((err = i2c_attach_client(client))) {
513 dev_err(&adapter->dev, "max6650: failed to attach client.\n");
518 * Initialize the max6650 chip
520 if (max6650_init_client(client))
523 err = sysfs_create_group(&client->dev.kobj, &max6650_attr_grp);
527 data->hwmon_dev = hwmon_device_register(&client->dev);
528 if (!IS_ERR(data->hwmon_dev))
531 err = PTR_ERR(data->hwmon_dev);
532 dev_err(&client->dev, "error registering hwmon device.\n");
533 sysfs_remove_group(&client->dev.kobj, &max6650_attr_grp);
535 i2c_detach_client(client);
541 static int max6650_detach_client(struct i2c_client *client)
543 struct max6650_data *data = i2c_get_clientdata(client);
546 sysfs_remove_group(&client->dev.kobj, &max6650_attr_grp);
547 hwmon_device_unregister(data->hwmon_dev);
548 err = i2c_detach_client(client);
554 static int max6650_init_client(struct i2c_client *client)
556 struct max6650_data *data = i2c_get_clientdata(client);
560 config = i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG);
563 dev_err(&client->dev, "Error reading config, aborting.\n");
567 switch (fan_voltage) {
571 config &= ~MAX6650_CFG_V12;
574 config |= MAX6650_CFG_V12;
577 dev_err(&client->dev,
578 "illegal value for fan_voltage (%d)\n",
582 dev_info(&client->dev, "Fan voltage is set to %dV.\n",
583 (config & MAX6650_CFG_V12) ? 12 : 5);
589 config &= ~MAX6650_CFG_PRESCALER_MASK;
592 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
593 | MAX6650_CFG_PRESCALER_2;
596 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
597 | MAX6650_CFG_PRESCALER_4;
600 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
601 | MAX6650_CFG_PRESCALER_8;
604 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
605 | MAX6650_CFG_PRESCALER_16;
608 dev_err(&client->dev,
609 "illegal value for prescaler (%d)\n",
613 dev_info(&client->dev, "Prescaler is set to %d.\n",
614 1 << (config & MAX6650_CFG_PRESCALER_MASK));
616 /* If mode is set to "full off", we change it to "open loop" and
617 * set DAC to 255, which has the same effect. We do this because
618 * there's no "full off" mode defined in hwmon specifcations.
621 if ((config & MAX6650_CFG_MODE_MASK) == MAX6650_CFG_MODE_OFF) {
622 dev_dbg(&client->dev, "Change mode to open loop, full off.\n");
623 config = (config & ~MAX6650_CFG_MODE_MASK)
624 | MAX6650_CFG_MODE_OPEN_LOOP;
625 if (i2c_smbus_write_byte_data(client, MAX6650_REG_DAC, 255)) {
626 dev_err(&client->dev, "DAC write error, aborting.\n");
631 if (i2c_smbus_write_byte_data(client, MAX6650_REG_CONFIG, config)) {
632 dev_err(&client->dev, "Config write error, aborting.\n");
636 data->config = config;
637 data->count = i2c_smbus_read_byte_data(client, MAX6650_REG_COUNT);
642 static const u8 tach_reg[] = {
649 static struct max6650_data *max6650_update_device(struct device *dev)
652 struct i2c_client *client = to_i2c_client(dev);
653 struct max6650_data *data = i2c_get_clientdata(client);
655 mutex_lock(&data->update_lock);
657 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
658 data->speed = i2c_smbus_read_byte_data(client,
660 data->config = i2c_smbus_read_byte_data(client,
662 for (i = 0; i < 4; i++) {
663 data->tach[i] = i2c_smbus_read_byte_data(client,
666 data->count = i2c_smbus_read_byte_data(client,
668 data->dac = i2c_smbus_read_byte_data(client, MAX6650_REG_DAC);
670 data->last_updated = jiffies;
674 mutex_unlock(&data->update_lock);
679 static int __init sensors_max6650_init(void)
681 return i2c_add_driver(&max6650_driver);
684 static void __exit sensors_max6650_exit(void)
686 i2c_del_driver(&max6650_driver);
689 MODULE_AUTHOR("Hans J. Koch");
690 MODULE_DESCRIPTION("MAX6650 sensor driver");
691 MODULE_LICENSE("GPL");
693 module_init(sensors_max6650_init);
694 module_exit(sensors_max6650_exit);