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 unsigned short normal_i2c[] = {0x1b, 0x1f, 0x48, 0x4b, I2C_CLIENT_END};
53 /* fan_voltage: 5=5V fan, 12=12V fan, 0=don't change */
54 static int fan_voltage;
55 /* prescaler: Possible values are 1, 2, 4, 8, 16 or 0 for don't change */
57 /* clock: The clock frequency of the chip the driver should assume */
58 static int clock = 254000;
60 module_param(fan_voltage, int, S_IRUGO);
61 module_param(prescaler, int, S_IRUGO);
62 module_param(clock, int, S_IRUGO);
64 I2C_CLIENT_INSMOD_1(max6650);
67 * MAX 6650/6651 registers
70 #define MAX6650_REG_SPEED 0x00
71 #define MAX6650_REG_CONFIG 0x02
72 #define MAX6650_REG_GPIO_DEF 0x04
73 #define MAX6650_REG_DAC 0x06
74 #define MAX6650_REG_ALARM_EN 0x08
75 #define MAX6650_REG_ALARM 0x0A
76 #define MAX6650_REG_TACH0 0x0C
77 #define MAX6650_REG_TACH1 0x0E
78 #define MAX6650_REG_TACH2 0x10
79 #define MAX6650_REG_TACH3 0x12
80 #define MAX6650_REG_GPIO_STAT 0x14
81 #define MAX6650_REG_COUNT 0x16
84 * Config register bits
87 #define MAX6650_CFG_V12 0x08
88 #define MAX6650_CFG_PRESCALER_MASK 0x07
89 #define MAX6650_CFG_PRESCALER_2 0x01
90 #define MAX6650_CFG_PRESCALER_4 0x02
91 #define MAX6650_CFG_PRESCALER_8 0x03
92 #define MAX6650_CFG_PRESCALER_16 0x04
93 #define MAX6650_CFG_MODE_MASK 0x30
94 #define MAX6650_CFG_MODE_ON 0x00
95 #define MAX6650_CFG_MODE_OFF 0x10
96 #define MAX6650_CFG_MODE_CLOSED_LOOP 0x20
97 #define MAX6650_CFG_MODE_OPEN_LOOP 0x30
98 #define MAX6650_COUNT_MASK 0x03
100 /* Minimum and maximum values of the FAN-RPM */
101 #define FAN_RPM_MIN 240
102 #define FAN_RPM_MAX 30000
104 #define DIV_FROM_REG(reg) (1 << (reg & 7))
106 static int max6650_attach_adapter(struct i2c_adapter *adapter);
107 static int max6650_detect(struct i2c_adapter *adapter, int address, int kind);
108 static int max6650_init_client(struct i2c_client *client);
109 static int max6650_detach_client(struct i2c_client *client);
110 static struct max6650_data *max6650_update_device(struct device *dev);
113 * Driver data (common to all clients)
116 static struct i2c_driver max6650_driver = {
120 .attach_adapter = max6650_attach_adapter,
121 .detach_client = max6650_detach_client,
125 * Client data (each client gets its own)
130 struct i2c_client client;
131 struct class_device *class_dev;
132 struct mutex update_lock;
133 char valid; /* zero until following fields are valid */
134 unsigned long last_updated; /* in jiffies */
136 /* register values */
144 static ssize_t get_fan(struct device *dev, struct device_attribute *devattr,
147 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
148 struct max6650_data *data = max6650_update_device(dev);
152 * Calculation details:
154 * Each tachometer counts over an interval given by the "count"
155 * register (0.25, 0.5, 1 or 2 seconds). This module assumes
156 * that the fans produce two pulses per revolution (this seems
157 * to be the most common).
160 rpm = ((data->tach[attr->index] * 120) / DIV_FROM_REG(data->count));
161 return sprintf(buf, "%d\n", rpm);
165 * Set the fan speed to the specified RPM (or read back the RPM setting).
166 * This works in closed loop mode only. Use pwm1 for open loop speed setting.
168 * The MAX6650/1 will automatically control fan speed when in closed loop
173 * 1) The MAX6650/1 internal 254kHz clock frequency is set correctly. Use
174 * the clock module parameter if you need to fine tune this.
176 * 2) The prescaler (low three bits of the config register) has already
177 * been set to an appropriate value. Use the prescaler module parameter
178 * if your BIOS doesn't initialize the chip properly.
180 * The relevant equations are given on pages 21 and 22 of the datasheet.
182 * From the datasheet, the relevant equation when in regulation is:
184 * [fCLK / (128 x (KTACH + 1))] = 2 x FanSpeed / KSCALE
188 * fCLK is the oscillator frequency (either the 254kHz internal
189 * oscillator or the externally applied clock)
191 * KTACH is the value in the speed register
193 * FanSpeed is the speed of the fan in rps
195 * KSCALE is the prescaler value (1, 2, 4, 8, or 16)
197 * When reading, we need to solve for FanSpeed. When writing, we need to
200 * Note: this tachometer is completely separate from the tachometers
201 * used to measure the fan speeds. Only one fan's speed (fan1) is
205 static ssize_t get_target(struct device *dev, struct device_attribute *devattr,
208 struct max6650_data *data = max6650_update_device(dev);
209 int kscale, ktach, rpm;
212 * Use the datasheet equation:
214 * FanSpeed = KSCALE x fCLK / [256 x (KTACH + 1)]
216 * then multiply by 60 to give rpm.
219 kscale = DIV_FROM_REG(data->config);
221 rpm = 60 * kscale * clock / (256 * (ktach + 1));
222 return sprintf(buf, "%d\n", rpm);
225 static ssize_t set_target(struct device *dev, struct device_attribute *devattr,
226 const char *buf, size_t count)
228 struct i2c_client *client = to_i2c_client(dev);
229 struct max6650_data *data = i2c_get_clientdata(client);
230 int rpm = simple_strtoul(buf, NULL, 10);
233 rpm = SENSORS_LIMIT(rpm, FAN_RPM_MIN, FAN_RPM_MAX);
236 * Divide the required speed by 60 to get from rpm to rps, then
237 * use the datasheet equation:
239 * KTACH = [(fCLK x KSCALE) / (256 x FanSpeed)] - 1
242 mutex_lock(&data->update_lock);
244 kscale = DIV_FROM_REG(data->config);
245 ktach = ((clock * kscale) / (256 * rpm / 60)) - 1;
252 i2c_smbus_write_byte_data(client, MAX6650_REG_SPEED, data->speed);
254 mutex_unlock(&data->update_lock);
260 * Get/set the fan speed in open loop mode using pwm1 sysfs file.
261 * Speed is given as a relative value from 0 to 255, where 255 is maximum
262 * speed. Note that this is done by writing directly to the chip's DAC,
263 * it won't change the closed loop speed set by fan1_target.
264 * Also note that due to rounding errors it is possible that you don't read
265 * back exactly the value you have set.
268 static ssize_t get_pwm(struct device *dev, struct device_attribute *devattr,
272 struct max6650_data *data = max6650_update_device(dev);
274 /* Useful range for dac is 0-180 for 12V fans and 0-76 for 5V fans.
275 Lower DAC values mean higher speeds. */
276 if (data->config & MAX6650_CFG_V12)
277 pwm = 255 - (255 * (int)data->dac)/180;
279 pwm = 255 - (255 * (int)data->dac)/76;
284 return sprintf(buf, "%d\n", pwm);
287 static ssize_t set_pwm(struct device *dev, struct device_attribute *devattr,
288 const char *buf, size_t count)
290 struct i2c_client *client = to_i2c_client(dev);
291 struct max6650_data *data = i2c_get_clientdata(client);
292 int pwm = simple_strtoul(buf, NULL, 10);
294 pwm = SENSORS_LIMIT(pwm, 0, 255);
296 mutex_lock(&data->update_lock);
298 if (data->config & MAX6650_CFG_V12)
299 data->dac = 180 - (180 * pwm)/255;
301 data->dac = 76 - (76 * pwm)/255;
303 i2c_smbus_write_byte_data(client, MAX6650_REG_DAC, data->dac);
305 mutex_unlock(&data->update_lock);
311 * Get/Set controller mode:
314 * 1 = Open loop, Voltage is set according to speed, not regulated.
315 * 2 = Closed loop, RPM for all fans regulated by fan1 tachometer
318 static ssize_t get_enable(struct device *dev, struct device_attribute *devattr,
321 struct max6650_data *data = max6650_update_device(dev);
322 int mode = (data->config & MAX6650_CFG_MODE_MASK) >> 4;
323 int sysfs_modes[4] = {0, 1, 2, 1};
325 return sprintf(buf, "%d\n", sysfs_modes[mode]);
328 static ssize_t set_enable(struct device *dev, struct device_attribute *devattr,
329 const char *buf, size_t count)
331 struct i2c_client *client = to_i2c_client(dev);
332 struct max6650_data *data = i2c_get_clientdata(client);
333 int mode = simple_strtoul(buf, NULL, 10);
334 int max6650_modes[3] = {0, 3, 2};
336 if ((mode < 0)||(mode > 2)) {
337 dev_err(&client->dev,
338 "illegal value for pwm1_enable (%d)\n", mode);
342 mutex_lock(&data->update_lock);
344 data->config = i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG);
345 data->config = (data->config & ~MAX6650_CFG_MODE_MASK)
346 | (max6650_modes[mode] << 4);
348 i2c_smbus_write_byte_data(client, MAX6650_REG_CONFIG, data->config);
350 mutex_unlock(&data->update_lock);
356 * Read/write functions for fan1_div sysfs file. The MAX6650 has no such
357 * divider. We handle this by converting between divider and counttime:
359 * (counttime == k) <==> (divider == 2^k), k = 0, 1, 2, or 3
361 * Lower values of k allow to connect a faster fan without the risk of
362 * counter overflow. The price is lower resolution. You can also set counttime
363 * using the module parameter. Note that the module parameter "prescaler" also
364 * influences the behaviour. Unfortunately, there's no sysfs attribute
365 * defined for that. See the data sheet for details.
368 static ssize_t get_div(struct device *dev, struct device_attribute *devattr,
371 struct max6650_data *data = max6650_update_device(dev);
373 return sprintf(buf, "%d\n", DIV_FROM_REG(data->count));
376 static ssize_t set_div(struct device *dev, struct device_attribute *devattr,
377 const char *buf, size_t count)
379 struct i2c_client *client = to_i2c_client(dev);
380 struct max6650_data *data = i2c_get_clientdata(client);
381 int div = simple_strtoul(buf, NULL, 10);
383 mutex_lock(&data->update_lock);
398 dev_err(&client->dev,
399 "illegal value for fan divider (%d)\n", div);
403 i2c_smbus_write_byte_data(client, MAX6650_REG_COUNT, data->count);
404 mutex_unlock(&data->update_lock);
409 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, get_fan, NULL, 0);
410 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, get_fan, NULL, 1);
411 static SENSOR_DEVICE_ATTR(fan3_input, S_IRUGO, get_fan, NULL, 2);
412 static SENSOR_DEVICE_ATTR(fan4_input, S_IRUGO, get_fan, NULL, 3);
413 static DEVICE_ATTR(fan1_target, S_IWUSR | S_IRUGO, get_target, set_target);
414 static DEVICE_ATTR(fan1_div, S_IWUSR | S_IRUGO, get_div, set_div);
415 static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO, get_enable, set_enable);
416 static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, get_pwm, set_pwm);
419 static struct attribute *max6650_attrs[] = {
420 &sensor_dev_attr_fan1_input.dev_attr.attr,
421 &sensor_dev_attr_fan2_input.dev_attr.attr,
422 &sensor_dev_attr_fan3_input.dev_attr.attr,
423 &sensor_dev_attr_fan4_input.dev_attr.attr,
424 &dev_attr_fan1_target.attr,
425 &dev_attr_fan1_div.attr,
426 &dev_attr_pwm1_enable.attr,
431 static struct attribute_group max6650_attr_grp = {
432 .attrs = max6650_attrs,
439 static int max6650_attach_adapter(struct i2c_adapter *adapter)
441 if (!(adapter->class & I2C_CLASS_HWMON)) {
442 dev_dbg(&adapter->dev,
443 "FATAL: max6650_attach_adapter class HWMON not set\n");
447 return i2c_probe(adapter, &addr_data, max6650_detect);
451 * The following function does more than just detection. If detection
452 * succeeds, it also registers the new chip.
455 static int max6650_detect(struct i2c_adapter *adapter, int address, int kind)
457 struct i2c_client *client;
458 struct max6650_data *data;
461 dev_dbg(&adapter->dev, "max6650_detect called, kind = %d\n", kind);
463 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
464 dev_dbg(&adapter->dev, "max6650: I2C bus doesn't support "
465 "byte read mode, skipping.\n");
469 if (!(data = kzalloc(sizeof(struct max6650_data), GFP_KERNEL))) {
470 dev_err(&adapter->dev, "max6650: out of memory.\n");
474 client = &data->client;
475 i2c_set_clientdata(client, data);
476 client->addr = address;
477 client->adapter = adapter;
478 client->driver = &max6650_driver;
481 * Now we do the remaining detection. A negative kind means that
482 * the driver was loaded with no force parameter (default), so we
483 * must both detect and identify the chip (actually there is only
484 * one possible kind of chip for now, max6650). A zero kind means that
485 * the driver was loaded with the force parameter, the detection
486 * step shall be skipped. A positive kind means that the driver
487 * was loaded with the force parameter and a given kind of chip is
488 * requested, so both the detection and the identification steps
491 * Currently I can find no way to distinguish between a MAX6650 and
492 * a MAX6651. This driver has only been tried on the former.
496 ( (i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG) & 0xC0)
497 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_GPIO_STAT) & 0xE0)
498 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM_EN) & 0xE0)
499 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_ALARM) & 0xE0)
500 ||(i2c_smbus_read_byte_data(client, MAX6650_REG_COUNT) & 0xFC))) {
501 dev_dbg(&adapter->dev,
502 "max6650: detection failed at 0x%02x.\n", address);
506 dev_info(&adapter->dev, "max6650: chip found at 0x%02x.\n", address);
508 strlcpy(client->name, "max6650", I2C_NAME_SIZE);
509 mutex_init(&data->update_lock);
511 if ((err = i2c_attach_client(client))) {
512 dev_err(&adapter->dev, "max6650: failed to attach client.\n");
517 * Initialize the max6650 chip
519 if (max6650_init_client(client))
522 err = sysfs_create_group(&client->dev.kobj, &max6650_attr_grp);
526 data->class_dev = hwmon_device_register(&client->dev);
527 if (!IS_ERR(data->class_dev))
530 err = PTR_ERR(data->class_dev);
531 dev_err(&client->dev, "error registering hwmon device.\n");
532 sysfs_remove_group(&client->dev.kobj, &max6650_attr_grp);
534 i2c_detach_client(client);
540 static int max6650_detach_client(struct i2c_client *client)
542 struct max6650_data *data = i2c_get_clientdata(client);
545 sysfs_remove_group(&client->dev.kobj, &max6650_attr_grp);
546 hwmon_device_unregister(data->class_dev);
547 err = i2c_detach_client(client);
553 static int max6650_init_client(struct i2c_client *client)
555 struct max6650_data *data = i2c_get_clientdata(client);
559 config = i2c_smbus_read_byte_data(client, MAX6650_REG_CONFIG);
562 dev_err(&client->dev, "Error reading config, aborting.\n");
566 switch (fan_voltage) {
570 config &= ~MAX6650_CFG_V12;
573 config |= MAX6650_CFG_V12;
576 dev_err(&client->dev,
577 "illegal value for fan_voltage (%d)\n",
581 dev_info(&client->dev, "Fan voltage is set to %dV.\n",
582 (config & MAX6650_CFG_V12) ? 12 : 5);
588 config &= ~MAX6650_CFG_PRESCALER_MASK;
591 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
592 | MAX6650_CFG_PRESCALER_2;
595 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
596 | MAX6650_CFG_PRESCALER_4;
599 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
600 | MAX6650_CFG_PRESCALER_8;
603 config = (config & ~MAX6650_CFG_PRESCALER_MASK)
604 | MAX6650_CFG_PRESCALER_16;
607 dev_err(&client->dev,
608 "illegal value for prescaler (%d)\n",
612 dev_info(&client->dev, "Prescaler is set to %d.\n",
613 1 << (config & MAX6650_CFG_PRESCALER_MASK));
615 /* If mode is set to "full off", we change it to "open loop" and
616 * set DAC to 255, which has the same effect. We do this because
617 * there's no "full off" mode defined in hwmon specifcations.
620 if ((config & MAX6650_CFG_MODE_MASK) == MAX6650_CFG_MODE_OFF) {
621 dev_dbg(&client->dev, "Change mode to open loop, full off.\n");
622 config = (config & ~MAX6650_CFG_MODE_MASK)
623 | MAX6650_CFG_MODE_OPEN_LOOP;
624 if (i2c_smbus_write_byte_data(client, MAX6650_REG_DAC, 255)) {
625 dev_err(&client->dev, "DAC write error, aborting.\n");
630 if (i2c_smbus_write_byte_data(client, MAX6650_REG_CONFIG, config)) {
631 dev_err(&client->dev, "Config write error, aborting.\n");
635 data->config = config;
636 data->count = i2c_smbus_read_byte_data(client, MAX6650_REG_COUNT);
641 static const u8 tach_reg[] = {
648 static struct max6650_data *max6650_update_device(struct device *dev)
651 struct i2c_client *client = to_i2c_client(dev);
652 struct max6650_data *data = i2c_get_clientdata(client);
654 mutex_lock(&data->update_lock);
656 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
657 data->speed = i2c_smbus_read_byte_data(client,
659 data->config = i2c_smbus_read_byte_data(client,
661 for (i = 0; i < 4; i++) {
662 data->tach[i] = i2c_smbus_read_byte_data(client,
665 data->count = i2c_smbus_read_byte_data(client,
667 data->dac = i2c_smbus_read_byte_data(client, MAX6650_REG_DAC);
669 data->last_updated = jiffies;
673 mutex_unlock(&data->update_lock);
678 static int __init sensors_max6650_init(void)
680 return i2c_add_driver(&max6650_driver);
683 static void __exit sensors_max6650_exit(void)
685 i2c_del_driver(&max6650_driver);
688 MODULE_AUTHOR("Hans J. Koch");
689 MODULE_DESCRIPTION("MAX6650 sensor driver");
690 MODULE_LICENSE("GPL");
692 module_init(sensors_max6650_init);
693 module_exit(sensors_max6650_exit);