2 smsc47m1.c - Part of lm_sensors, Linux kernel modules
3 for hardware monitoring
5 Supports the SMSC LPC47B27x, LPC47M10x, LPC47M112, LPC47M13x,
6 LPC47M14x, LPC47M15x, LPC47M192 and LPC47M997 Super-I/O chips.
8 Copyright (C) 2002 Mark D. Studebaker <mdsxyz123@yahoo.com>
9 Copyright (C) 2004 Jean Delvare <khali@linux-fr.org>
10 Ported to Linux 2.6 by Gabriele Gorla <gorlik@yahoo.com>
13 This program is free software; you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation; either version 2 of the License, or
16 (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <linux/module.h>
29 #include <linux/slab.h>
30 #include <linux/ioport.h>
31 #include <linux/jiffies.h>
32 #include <linux/i2c.h>
33 #include <linux/i2c-isa.h>
34 #include <linux/hwmon.h>
35 #include <linux/err.h>
36 #include <linux/init.h>
37 #include <linux/mutex.h>
38 #include <linux/sysfs.h>
41 /* Address is autodetected, there is no default value */
42 static unsigned short address;
44 /* Super-I/0 registers and commands */
46 #define REG 0x2e /* The register to read/write */
47 #define VAL 0x2f /* The value to read/write */
50 superio_outb(int reg, int val)
63 /* logical device for fans is 0x0A */
64 #define superio_select() superio_outb(0x07, 0x0A)
78 #define SUPERIO_REG_ACT 0x30
79 #define SUPERIO_REG_BASE 0x60
80 #define SUPERIO_REG_DEVID 0x20
82 /* Logical device registers */
84 #define SMSC_EXTENT 0x80
86 /* nr is 0 or 1 in the macros below */
87 #define SMSC47M1_REG_ALARM 0x04
88 #define SMSC47M1_REG_TPIN(nr) (0x34 - (nr))
89 #define SMSC47M1_REG_PPIN(nr) (0x36 - (nr))
90 #define SMSC47M1_REG_PWM(nr) (0x56 + (nr))
91 #define SMSC47M1_REG_FANDIV 0x58
92 #define SMSC47M1_REG_FAN(nr) (0x59 + (nr))
93 #define SMSC47M1_REG_FAN_PRELOAD(nr) (0x5B + (nr))
95 #define MIN_FROM_REG(reg,div) ((reg)>=192 ? 0 : \
96 983040/((192-(reg))*(div)))
97 #define FAN_FROM_REG(reg,div,preload) ((reg)<=(preload) || (reg)==255 ? 0 : \
98 983040/(((reg)-(preload))*(div)))
99 #define DIV_FROM_REG(reg) (1 << (reg))
100 #define PWM_FROM_REG(reg) (((reg) & 0x7E) << 1)
101 #define PWM_EN_FROM_REG(reg) ((~(reg)) & 0x01)
102 #define PWM_TO_REG(reg) (((reg) >> 1) & 0x7E)
104 struct smsc47m1_data {
105 struct i2c_client client;
106 struct class_device *class_dev;
109 struct mutex update_lock;
110 unsigned long last_updated; /* In jiffies */
112 u8 fan[2]; /* Register value */
113 u8 fan_preload[2]; /* Register value */
114 u8 fan_div[2]; /* Register encoding, shifted right */
115 u8 alarms; /* Register encoding */
116 u8 pwm[2]; /* Register value (bit 7 is enable) */
120 static int smsc47m1_detect(struct i2c_adapter *adapter);
121 static int smsc47m1_detach_client(struct i2c_client *client);
123 static int smsc47m1_read_value(struct i2c_client *client, u8 reg);
124 static void smsc47m1_write_value(struct i2c_client *client, u8 reg, u8 value);
126 static struct smsc47m1_data *smsc47m1_update_device(struct device *dev,
130 static struct i2c_driver smsc47m1_driver = {
132 .owner = THIS_MODULE,
135 .attach_adapter = smsc47m1_detect,
136 .detach_client = smsc47m1_detach_client,
139 /* nr is 0 or 1 in the callback functions below */
141 static ssize_t get_fan(struct device *dev, char *buf, int nr)
143 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
144 /* This chip (stupidly) stops monitoring fan speed if PWM is
145 enabled and duty cycle is 0%. This is fine if the monitoring
146 and control concern the same fan, but troublesome if they are
147 not (which could as well happen). */
148 int rpm = (data->pwm[nr] & 0x7F) == 0x00 ? 0 :
149 FAN_FROM_REG(data->fan[nr],
150 DIV_FROM_REG(data->fan_div[nr]),
151 data->fan_preload[nr]);
152 return sprintf(buf, "%d\n", rpm);
155 static ssize_t get_fan_min(struct device *dev, char *buf, int nr)
157 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
158 int rpm = MIN_FROM_REG(data->fan_preload[nr],
159 DIV_FROM_REG(data->fan_div[nr]));
160 return sprintf(buf, "%d\n", rpm);
163 static ssize_t get_fan_div(struct device *dev, char *buf, int nr)
165 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
166 return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]));
169 static ssize_t get_pwm(struct device *dev, char *buf, int nr)
171 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
172 return sprintf(buf, "%d\n", PWM_FROM_REG(data->pwm[nr]));
175 static ssize_t get_pwm_en(struct device *dev, char *buf, int nr)
177 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
178 return sprintf(buf, "%d\n", PWM_EN_FROM_REG(data->pwm[nr]));
181 static ssize_t get_alarms(struct device *dev, struct device_attribute *attr, char *buf)
183 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
184 return sprintf(buf, "%d\n", data->alarms);
187 static ssize_t set_fan_min(struct device *dev, const char *buf,
188 size_t count, int nr)
190 struct i2c_client *client = to_i2c_client(dev);
191 struct smsc47m1_data *data = i2c_get_clientdata(client);
192 long rpmdiv, val = simple_strtol(buf, NULL, 10);
194 mutex_lock(&data->update_lock);
195 rpmdiv = val * DIV_FROM_REG(data->fan_div[nr]);
197 if (983040 > 192 * rpmdiv || 2 * rpmdiv > 983040) {
198 mutex_unlock(&data->update_lock);
202 data->fan_preload[nr] = 192 - ((983040 + rpmdiv / 2) / rpmdiv);
203 smsc47m1_write_value(client, SMSC47M1_REG_FAN_PRELOAD(nr),
204 data->fan_preload[nr]);
205 mutex_unlock(&data->update_lock);
210 /* Note: we save and restore the fan minimum here, because its value is
211 determined in part by the fan clock divider. This follows the principle
212 of least surprise; the user doesn't expect the fan minimum to change just
213 because the divider changed. */
214 static ssize_t set_fan_div(struct device *dev, const char *buf,
215 size_t count, int nr)
217 struct i2c_client *client = to_i2c_client(dev);
218 struct smsc47m1_data *data = i2c_get_clientdata(client);
220 long new_div = simple_strtol(buf, NULL, 10), tmp;
221 u8 old_div = DIV_FROM_REG(data->fan_div[nr]);
223 if (new_div == old_div) /* No change */
226 mutex_lock(&data->update_lock);
228 case 1: data->fan_div[nr] = 0; break;
229 case 2: data->fan_div[nr] = 1; break;
230 case 4: data->fan_div[nr] = 2; break;
231 case 8: data->fan_div[nr] = 3; break;
233 mutex_unlock(&data->update_lock);
237 tmp = smsc47m1_read_value(client, SMSC47M1_REG_FANDIV) & 0x0F;
238 tmp |= (data->fan_div[0] << 4) | (data->fan_div[1] << 6);
239 smsc47m1_write_value(client, SMSC47M1_REG_FANDIV, tmp);
241 /* Preserve fan min */
242 tmp = 192 - (old_div * (192 - data->fan_preload[nr])
243 + new_div / 2) / new_div;
244 data->fan_preload[nr] = SENSORS_LIMIT(tmp, 0, 191);
245 smsc47m1_write_value(client, SMSC47M1_REG_FAN_PRELOAD(nr),
246 data->fan_preload[nr]);
247 mutex_unlock(&data->update_lock);
252 static ssize_t set_pwm(struct device *dev, const char *buf,
253 size_t count, int nr)
255 struct i2c_client *client = to_i2c_client(dev);
256 struct smsc47m1_data *data = i2c_get_clientdata(client);
258 long val = simple_strtol(buf, NULL, 10);
260 if (val < 0 || val > 255)
263 mutex_lock(&data->update_lock);
264 data->pwm[nr] &= 0x81; /* Preserve additional bits */
265 data->pwm[nr] |= PWM_TO_REG(val);
266 smsc47m1_write_value(client, SMSC47M1_REG_PWM(nr),
268 mutex_unlock(&data->update_lock);
273 static ssize_t set_pwm_en(struct device *dev, const char *buf,
274 size_t count, int nr)
276 struct i2c_client *client = to_i2c_client(dev);
277 struct smsc47m1_data *data = i2c_get_clientdata(client);
279 long val = simple_strtol(buf, NULL, 10);
281 if (val != 0 && val != 1)
284 mutex_lock(&data->update_lock);
285 data->pwm[nr] &= 0xFE; /* preserve the other bits */
286 data->pwm[nr] |= !val;
287 smsc47m1_write_value(client, SMSC47M1_REG_PWM(nr),
289 mutex_unlock(&data->update_lock);
294 #define fan_present(offset) \
295 static ssize_t get_fan##offset (struct device *dev, struct device_attribute *attr, char *buf) \
297 return get_fan(dev, buf, offset - 1); \
299 static ssize_t get_fan##offset##_min (struct device *dev, struct device_attribute *attr, char *buf) \
301 return get_fan_min(dev, buf, offset - 1); \
303 static ssize_t set_fan##offset##_min (struct device *dev, struct device_attribute *attr, \
304 const char *buf, size_t count) \
306 return set_fan_min(dev, buf, count, offset - 1); \
308 static ssize_t get_fan##offset##_div (struct device *dev, struct device_attribute *attr, char *buf) \
310 return get_fan_div(dev, buf, offset - 1); \
312 static ssize_t set_fan##offset##_div (struct device *dev, struct device_attribute *attr, \
313 const char *buf, size_t count) \
315 return set_fan_div(dev, buf, count, offset - 1); \
317 static ssize_t get_pwm##offset (struct device *dev, struct device_attribute *attr, char *buf) \
319 return get_pwm(dev, buf, offset - 1); \
321 static ssize_t set_pwm##offset (struct device *dev, struct device_attribute *attr, \
322 const char *buf, size_t count) \
324 return set_pwm(dev, buf, count, offset - 1); \
326 static ssize_t get_pwm##offset##_en (struct device *dev, struct device_attribute *attr, char *buf) \
328 return get_pwm_en(dev, buf, offset - 1); \
330 static ssize_t set_pwm##offset##_en (struct device *dev, struct device_attribute *attr, \
331 const char *buf, size_t count) \
333 return set_pwm_en(dev, buf, count, offset - 1); \
335 static DEVICE_ATTR(fan##offset##_input, S_IRUGO, get_fan##offset, \
337 static DEVICE_ATTR(fan##offset##_min, S_IRUGO | S_IWUSR, \
338 get_fan##offset##_min, set_fan##offset##_min); \
339 static DEVICE_ATTR(fan##offset##_div, S_IRUGO | S_IWUSR, \
340 get_fan##offset##_div, set_fan##offset##_div); \
341 static DEVICE_ATTR(pwm##offset, S_IRUGO | S_IWUSR, \
342 get_pwm##offset, set_pwm##offset); \
343 static DEVICE_ATTR(pwm##offset##_enable, S_IRUGO | S_IWUSR, \
344 get_pwm##offset##_en, set_pwm##offset##_en);
349 static DEVICE_ATTR(alarms, S_IRUGO, get_alarms, NULL);
351 /* Almost all sysfs files may or may not be created depending on the chip
352 setup so we create them individually. It is still convenient to define a
353 group to remove them all at once. */
354 static struct attribute *smsc47m1_attributes[] = {
355 &dev_attr_fan1_input.attr,
356 &dev_attr_fan1_min.attr,
357 &dev_attr_fan1_div.attr,
358 &dev_attr_fan2_input.attr,
359 &dev_attr_fan2_min.attr,
360 &dev_attr_fan2_div.attr,
363 &dev_attr_pwm1_enable.attr,
365 &dev_attr_pwm2_enable.attr,
367 &dev_attr_alarms.attr,
371 static const struct attribute_group smsc47m1_group = {
372 .attrs = smsc47m1_attributes,
375 static int __init smsc47m1_find(unsigned short *addr)
380 val = superio_inb(SUPERIO_REG_DEVID);
383 * SMSC LPC47M10x/LPC47M112/LPC47M13x (device id 0x59), LPC47M14x
384 * (device id 0x5F) and LPC47B27x (device id 0x51) have fan control.
385 * The LPC47M15x and LPC47M192 chips "with hardware monitoring block"
386 * can do much more besides (device id 0x60).
387 * The LPC47M997 is undocumented, but seems to be compatible with
388 * the LPC47M192, and has the same device id.
391 printk(KERN_INFO "smsc47m1: Found SMSC LPC47B27x\n");
392 else if (val == 0x59)
393 printk(KERN_INFO "smsc47m1: Found SMSC "
394 "LPC47M10x/LPC47M112/LPC47M13x\n");
395 else if (val == 0x5F)
396 printk(KERN_INFO "smsc47m1: Found SMSC LPC47M14x\n");
397 else if (val == 0x60)
398 printk(KERN_INFO "smsc47m1: Found SMSC "
399 "LPC47M15x/LPC47M192/LPC47M997\n");
406 *addr = (superio_inb(SUPERIO_REG_BASE) << 8)
407 | superio_inb(SUPERIO_REG_BASE + 1);
408 val = superio_inb(SUPERIO_REG_ACT);
409 if (*addr == 0 || (val & 0x01) == 0) {
410 printk(KERN_INFO "smsc47m1: Device is disabled, will not use\n");
419 static int smsc47m1_detect(struct i2c_adapter *adapter)
421 struct i2c_client *new_client;
422 struct smsc47m1_data *data;
424 int fan1, fan2, pwm1, pwm2;
426 if (!request_region(address, SMSC_EXTENT, smsc47m1_driver.driver.name)) {
427 dev_err(&adapter->dev, "Region 0x%x already in use!\n", address);
431 if (!(data = kzalloc(sizeof(struct smsc47m1_data), GFP_KERNEL))) {
436 new_client = &data->client;
437 i2c_set_clientdata(new_client, data);
438 new_client->addr = address;
439 mutex_init(&data->lock);
440 new_client->adapter = adapter;
441 new_client->driver = &smsc47m1_driver;
442 new_client->flags = 0;
444 strlcpy(new_client->name, "smsc47m1", I2C_NAME_SIZE);
445 mutex_init(&data->update_lock);
447 /* If no function is properly configured, there's no point in
448 actually registering the chip. */
449 fan1 = (smsc47m1_read_value(new_client, SMSC47M1_REG_TPIN(0)) & 0x05)
451 fan2 = (smsc47m1_read_value(new_client, SMSC47M1_REG_TPIN(1)) & 0x05)
453 pwm1 = (smsc47m1_read_value(new_client, SMSC47M1_REG_PPIN(0)) & 0x05)
455 pwm2 = (smsc47m1_read_value(new_client, SMSC47M1_REG_PPIN(1)) & 0x05)
457 if (!(fan1 || fan2 || pwm1 || pwm2)) {
458 dev_warn(&adapter->dev, "Device at 0x%x is not configured, "
459 "will not use\n", new_client->addr);
464 if ((err = i2c_attach_client(new_client)))
467 /* Some values (fan min, clock dividers, pwm registers) may be
468 needed before any update is triggered, so we better read them
469 at least once here. We don't usually do it that way, but in
470 this particular case, manually reading 5 registers out of 8
471 doesn't make much sense and we're better using the existing
473 smsc47m1_update_device(&new_client->dev, 1);
475 /* Register sysfs hooks */
477 if ((err = device_create_file(&new_client->dev,
478 &dev_attr_fan1_input))
479 || (err = device_create_file(&new_client->dev,
481 || (err = device_create_file(&new_client->dev,
482 &dev_attr_fan1_div)))
483 goto error_remove_files;
485 dev_dbg(&new_client->dev, "Fan 1 not enabled by hardware, "
489 if ((err = device_create_file(&new_client->dev,
490 &dev_attr_fan2_input))
491 || (err = device_create_file(&new_client->dev,
493 || (err = device_create_file(&new_client->dev,
494 &dev_attr_fan2_div)))
495 goto error_remove_files;
497 dev_dbg(&new_client->dev, "Fan 2 not enabled by hardware, "
501 if ((err = device_create_file(&new_client->dev,
503 || (err = device_create_file(&new_client->dev,
504 &dev_attr_pwm1_enable)))
505 goto error_remove_files;
507 dev_dbg(&new_client->dev, "PWM 1 not enabled by hardware, "
510 if ((err = device_create_file(&new_client->dev,
512 || (err = device_create_file(&new_client->dev,
513 &dev_attr_pwm2_enable)))
514 goto error_remove_files;
516 dev_dbg(&new_client->dev, "PWM 2 not enabled by hardware, "
519 if ((err = device_create_file(&new_client->dev, &dev_attr_alarms)))
520 goto error_remove_files;
522 data->class_dev = hwmon_device_register(&new_client->dev);
523 if (IS_ERR(data->class_dev)) {
524 err = PTR_ERR(data->class_dev);
525 goto error_remove_files;
531 sysfs_remove_group(&new_client->dev.kobj, &smsc47m1_group);
532 i2c_detach_client(new_client);
536 release_region(address, SMSC_EXTENT);
540 static int smsc47m1_detach_client(struct i2c_client *client)
542 struct smsc47m1_data *data = i2c_get_clientdata(client);
545 hwmon_device_unregister(data->class_dev);
546 sysfs_remove_group(&client->dev.kobj, &smsc47m1_group);
548 if ((err = i2c_detach_client(client)))
551 release_region(client->addr, SMSC_EXTENT);
557 static int smsc47m1_read_value(struct i2c_client *client, u8 reg)
561 mutex_lock(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
562 res = inb_p(client->addr + reg);
563 mutex_unlock(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
567 static void smsc47m1_write_value(struct i2c_client *client, u8 reg, u8 value)
569 mutex_lock(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
570 outb_p(value, client->addr + reg);
571 mutex_unlock(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
574 static struct smsc47m1_data *smsc47m1_update_device(struct device *dev,
577 struct i2c_client *client = to_i2c_client(dev);
578 struct smsc47m1_data *data = i2c_get_clientdata(client);
580 mutex_lock(&data->update_lock);
582 if (time_after(jiffies, data->last_updated + HZ + HZ / 2) || init) {
585 for (i = 0; i < 2; i++) {
586 data->fan[i] = smsc47m1_read_value(client,
587 SMSC47M1_REG_FAN(i));
588 data->fan_preload[i] = smsc47m1_read_value(client,
589 SMSC47M1_REG_FAN_PRELOAD(i));
590 data->pwm[i] = smsc47m1_read_value(client,
591 SMSC47M1_REG_PWM(i));
594 i = smsc47m1_read_value(client, SMSC47M1_REG_FANDIV);
595 data->fan_div[0] = (i >> 4) & 0x03;
596 data->fan_div[1] = i >> 6;
598 data->alarms = smsc47m1_read_value(client,
599 SMSC47M1_REG_ALARM) >> 6;
600 /* Clear alarms if needed */
602 smsc47m1_write_value(client, SMSC47M1_REG_ALARM, 0xC0);
604 data->last_updated = jiffies;
607 mutex_unlock(&data->update_lock);
611 static int __init sm_smsc47m1_init(void)
613 if (smsc47m1_find(&address)) {
617 return i2c_isa_add_driver(&smsc47m1_driver);
620 static void __exit sm_smsc47m1_exit(void)
622 i2c_isa_del_driver(&smsc47m1_driver);
625 MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>");
626 MODULE_DESCRIPTION("SMSC LPC47M1xx fan sensors driver");
627 MODULE_LICENSE("GPL");
629 module_init(sm_smsc47m1_init);
630 module_exit(sm_smsc47m1_exit);