2 smsc47m1.c - Part of lm_sensors, Linux kernel modules
3 for hardware monitoring
5 Supports the SMSC LPC47B27x, LPC47M10x, LPC47M13x, LPC47M14x,
6 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>
39 /* Address is autodetected, there is no default value */
40 static unsigned short address;
42 /* Super-I/0 registers and commands */
44 #define REG 0x2e /* The register to read/write */
45 #define VAL 0x2f /* The value to read/write */
48 superio_outb(int reg, int val)
61 /* logical device for fans is 0x0A */
62 #define superio_select() superio_outb(0x07, 0x0A)
76 #define SUPERIO_REG_ACT 0x30
77 #define SUPERIO_REG_BASE 0x60
78 #define SUPERIO_REG_DEVID 0x20
80 /* Logical device registers */
82 #define SMSC_EXTENT 0x80
84 /* nr is 0 or 1 in the macros below */
85 #define SMSC47M1_REG_ALARM 0x04
86 #define SMSC47M1_REG_TPIN(nr) (0x34 - (nr))
87 #define SMSC47M1_REG_PPIN(nr) (0x36 - (nr))
88 #define SMSC47M1_REG_PWM(nr) (0x56 + (nr))
89 #define SMSC47M1_REG_FANDIV 0x58
90 #define SMSC47M1_REG_FAN(nr) (0x59 + (nr))
91 #define SMSC47M1_REG_FAN_PRELOAD(nr) (0x5B + (nr))
93 #define MIN_FROM_REG(reg,div) ((reg)>=192 ? 0 : \
94 983040/((192-(reg))*(div)))
95 #define FAN_FROM_REG(reg,div,preload) ((reg)<=(preload) || (reg)==255 ? 0 : \
96 983040/(((reg)-(preload))*(div)))
97 #define DIV_FROM_REG(reg) (1 << (reg))
98 #define PWM_FROM_REG(reg) (((reg) & 0x7E) << 1)
99 #define PWM_EN_FROM_REG(reg) ((~(reg)) & 0x01)
100 #define PWM_TO_REG(reg) (((reg) >> 1) & 0x7E)
102 struct smsc47m1_data {
103 struct i2c_client client;
104 struct class_device *class_dev;
105 struct semaphore lock;
107 struct semaphore update_lock;
108 unsigned long last_updated; /* In jiffies */
110 u8 fan[2]; /* Register value */
111 u8 fan_preload[2]; /* Register value */
112 u8 fan_div[2]; /* Register encoding, shifted right */
113 u8 alarms; /* Register encoding */
114 u8 pwm[2]; /* Register value (bit 7 is enable) */
118 static int smsc47m1_detect(struct i2c_adapter *adapter);
119 static int smsc47m1_detach_client(struct i2c_client *client);
121 static int smsc47m1_read_value(struct i2c_client *client, u8 reg);
122 static void smsc47m1_write_value(struct i2c_client *client, u8 reg, u8 value);
124 static struct smsc47m1_data *smsc47m1_update_device(struct device *dev,
128 static struct i2c_driver smsc47m1_driver = {
129 .owner = THIS_MODULE,
131 .attach_adapter = smsc47m1_detect,
132 .detach_client = smsc47m1_detach_client,
135 /* nr is 0 or 1 in the callback functions below */
137 static ssize_t get_fan(struct device *dev, char *buf, int nr)
139 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
140 /* This chip (stupidly) stops monitoring fan speed if PWM is
141 enabled and duty cycle is 0%. This is fine if the monitoring
142 and control concern the same fan, but troublesome if they are
143 not (which could as well happen). */
144 int rpm = (data->pwm[nr] & 0x7F) == 0x00 ? 0 :
145 FAN_FROM_REG(data->fan[nr],
146 DIV_FROM_REG(data->fan_div[nr]),
147 data->fan_preload[nr]);
148 return sprintf(buf, "%d\n", rpm);
151 static ssize_t get_fan_min(struct device *dev, char *buf, int nr)
153 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
154 int rpm = MIN_FROM_REG(data->fan_preload[nr],
155 DIV_FROM_REG(data->fan_div[nr]));
156 return sprintf(buf, "%d\n", rpm);
159 static ssize_t get_fan_div(struct device *dev, char *buf, int nr)
161 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
162 return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]));
165 static ssize_t get_pwm(struct device *dev, char *buf, int nr)
167 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
168 return sprintf(buf, "%d\n", PWM_FROM_REG(data->pwm[nr]));
171 static ssize_t get_pwm_en(struct device *dev, char *buf, int nr)
173 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
174 return sprintf(buf, "%d\n", PWM_EN_FROM_REG(data->pwm[nr]));
177 static ssize_t get_alarms(struct device *dev, struct device_attribute *attr, char *buf)
179 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
180 return sprintf(buf, "%d\n", data->alarms);
183 static ssize_t set_fan_min(struct device *dev, const char *buf,
184 size_t count, int nr)
186 struct i2c_client *client = to_i2c_client(dev);
187 struct smsc47m1_data *data = i2c_get_clientdata(client);
188 long rpmdiv, val = simple_strtol(buf, NULL, 10);
190 down(&data->update_lock);
191 rpmdiv = val * DIV_FROM_REG(data->fan_div[nr]);
193 if (983040 > 192 * rpmdiv || 2 * rpmdiv > 983040) {
194 up(&data->update_lock);
198 data->fan_preload[nr] = 192 - ((983040 + rpmdiv / 2) / rpmdiv);
199 smsc47m1_write_value(client, SMSC47M1_REG_FAN_PRELOAD(nr),
200 data->fan_preload[nr]);
201 up(&data->update_lock);
206 /* Note: we save and restore the fan minimum here, because its value is
207 determined in part by the fan clock divider. This follows the principle
208 of least suprise; the user doesn't expect the fan minimum to change just
209 because the divider changed. */
210 static ssize_t set_fan_div(struct device *dev, const char *buf,
211 size_t count, int nr)
213 struct i2c_client *client = to_i2c_client(dev);
214 struct smsc47m1_data *data = i2c_get_clientdata(client);
216 long new_div = simple_strtol(buf, NULL, 10), tmp;
217 u8 old_div = DIV_FROM_REG(data->fan_div[nr]);
219 if (new_div == old_div) /* No change */
222 down(&data->update_lock);
224 case 1: data->fan_div[nr] = 0; break;
225 case 2: data->fan_div[nr] = 1; break;
226 case 4: data->fan_div[nr] = 2; break;
227 case 8: data->fan_div[nr] = 3; break;
229 up(&data->update_lock);
233 tmp = smsc47m1_read_value(client, SMSC47M1_REG_FANDIV) & 0x0F;
234 tmp |= (data->fan_div[0] << 4) | (data->fan_div[1] << 6);
235 smsc47m1_write_value(client, SMSC47M1_REG_FANDIV, tmp);
237 /* Preserve fan min */
238 tmp = 192 - (old_div * (192 - data->fan_preload[nr])
239 + new_div / 2) / new_div;
240 data->fan_preload[nr] = SENSORS_LIMIT(tmp, 0, 191);
241 smsc47m1_write_value(client, SMSC47M1_REG_FAN_PRELOAD(nr),
242 data->fan_preload[nr]);
243 up(&data->update_lock);
248 static ssize_t set_pwm(struct device *dev, const char *buf,
249 size_t count, int nr)
251 struct i2c_client *client = to_i2c_client(dev);
252 struct smsc47m1_data *data = i2c_get_clientdata(client);
254 long val = simple_strtol(buf, NULL, 10);
256 if (val < 0 || val > 255)
259 down(&data->update_lock);
260 data->pwm[nr] &= 0x81; /* Preserve additional bits */
261 data->pwm[nr] |= PWM_TO_REG(val);
262 smsc47m1_write_value(client, SMSC47M1_REG_PWM(nr),
264 up(&data->update_lock);
269 static ssize_t set_pwm_en(struct device *dev, const char *buf,
270 size_t count, int nr)
272 struct i2c_client *client = to_i2c_client(dev);
273 struct smsc47m1_data *data = i2c_get_clientdata(client);
275 long val = simple_strtol(buf, NULL, 10);
277 if (val != 0 && val != 1)
280 down(&data->update_lock);
281 data->pwm[nr] &= 0xFE; /* preserve the other bits */
282 data->pwm[nr] |= !val;
283 smsc47m1_write_value(client, SMSC47M1_REG_PWM(nr),
285 up(&data->update_lock);
290 #define fan_present(offset) \
291 static ssize_t get_fan##offset (struct device *dev, struct device_attribute *attr, char *buf) \
293 return get_fan(dev, buf, offset - 1); \
295 static ssize_t get_fan##offset##_min (struct device *dev, struct device_attribute *attr, char *buf) \
297 return get_fan_min(dev, buf, offset - 1); \
299 static ssize_t set_fan##offset##_min (struct device *dev, struct device_attribute *attr, \
300 const char *buf, size_t count) \
302 return set_fan_min(dev, buf, count, offset - 1); \
304 static ssize_t get_fan##offset##_div (struct device *dev, struct device_attribute *attr, char *buf) \
306 return get_fan_div(dev, buf, offset - 1); \
308 static ssize_t set_fan##offset##_div (struct device *dev, struct device_attribute *attr, \
309 const char *buf, size_t count) \
311 return set_fan_div(dev, buf, count, offset - 1); \
313 static ssize_t get_pwm##offset (struct device *dev, struct device_attribute *attr, char *buf) \
315 return get_pwm(dev, buf, offset - 1); \
317 static ssize_t set_pwm##offset (struct device *dev, struct device_attribute *attr, \
318 const char *buf, size_t count) \
320 return set_pwm(dev, buf, count, offset - 1); \
322 static ssize_t get_pwm##offset##_en (struct device *dev, struct device_attribute *attr, char *buf) \
324 return get_pwm_en(dev, buf, offset - 1); \
326 static ssize_t set_pwm##offset##_en (struct device *dev, struct device_attribute *attr, \
327 const char *buf, size_t count) \
329 return set_pwm_en(dev, buf, count, offset - 1); \
331 static DEVICE_ATTR(fan##offset##_input, S_IRUGO, get_fan##offset, \
333 static DEVICE_ATTR(fan##offset##_min, S_IRUGO | S_IWUSR, \
334 get_fan##offset##_min, set_fan##offset##_min); \
335 static DEVICE_ATTR(fan##offset##_div, S_IRUGO | S_IWUSR, \
336 get_fan##offset##_div, set_fan##offset##_div); \
337 static DEVICE_ATTR(pwm##offset, S_IRUGO | S_IWUSR, \
338 get_pwm##offset, set_pwm##offset); \
339 static DEVICE_ATTR(pwm##offset##_enable, S_IRUGO | S_IWUSR, \
340 get_pwm##offset##_en, set_pwm##offset##_en);
345 static DEVICE_ATTR(alarms, S_IRUGO, get_alarms, NULL);
347 static int __init smsc47m1_find(unsigned short *addr)
352 val = superio_inb(SUPERIO_REG_DEVID);
355 * SMSC LPC47M10x/LPC47M13x (device id 0x59), LPC47M14x (device id
356 * 0x5F) and LPC47B27x (device id 0x51) have fan control.
357 * The LPC47M15x and LPC47M192 chips "with hardware monitoring block"
358 * can do much more besides (device id 0x60).
359 * The LPC47M997 is undocumented, but seems to be compatible with
360 * the LPC47M192, and has the same device id.
363 printk(KERN_INFO "smsc47m1: Found SMSC LPC47B27x\n");
364 else if (val == 0x59)
365 printk(KERN_INFO "smsc47m1: Found SMSC LPC47M10x/LPC47M13x\n");
366 else if (val == 0x5F)
367 printk(KERN_INFO "smsc47m1: Found SMSC LPC47M14x\n");
368 else if (val == 0x60)
369 printk(KERN_INFO "smsc47m1: Found SMSC "
370 "LPC47M15x/LPC47M192/LPC47M997\n");
377 *addr = (superio_inb(SUPERIO_REG_BASE) << 8)
378 | superio_inb(SUPERIO_REG_BASE + 1);
379 val = superio_inb(SUPERIO_REG_ACT);
380 if (*addr == 0 || (val & 0x01) == 0) {
381 printk(KERN_INFO "smsc47m1: Device is disabled, will not use\n");
390 static int smsc47m1_detect(struct i2c_adapter *adapter)
392 struct i2c_client *new_client;
393 struct smsc47m1_data *data;
395 int fan1, fan2, pwm1, pwm2;
397 if (!request_region(address, SMSC_EXTENT, smsc47m1_driver.name)) {
398 dev_err(&adapter->dev, "Region 0x%x already in use!\n", address);
402 if (!(data = kzalloc(sizeof(struct smsc47m1_data), GFP_KERNEL))) {
407 new_client = &data->client;
408 i2c_set_clientdata(new_client, data);
409 new_client->addr = address;
410 init_MUTEX(&data->lock);
411 new_client->adapter = adapter;
412 new_client->driver = &smsc47m1_driver;
413 new_client->flags = 0;
415 strlcpy(new_client->name, "smsc47m1", I2C_NAME_SIZE);
416 init_MUTEX(&data->update_lock);
418 /* If no function is properly configured, there's no point in
419 actually registering the chip. */
420 fan1 = (smsc47m1_read_value(new_client, SMSC47M1_REG_TPIN(0)) & 0x05)
422 fan2 = (smsc47m1_read_value(new_client, SMSC47M1_REG_TPIN(1)) & 0x05)
424 pwm1 = (smsc47m1_read_value(new_client, SMSC47M1_REG_PPIN(0)) & 0x05)
426 pwm2 = (smsc47m1_read_value(new_client, SMSC47M1_REG_PPIN(1)) & 0x05)
428 if (!(fan1 || fan2 || pwm1 || pwm2)) {
429 dev_warn(&new_client->dev, "Device is not configured, will not use\n");
434 if ((err = i2c_attach_client(new_client)))
437 /* Some values (fan min, clock dividers, pwm registers) may be
438 needed before any update is triggered, so we better read them
439 at least once here. We don't usually do it that way, but in
440 this particular case, manually reading 5 registers out of 8
441 doesn't make much sense and we're better using the existing
443 smsc47m1_update_device(&new_client->dev, 1);
445 /* Register sysfs hooks */
446 data->class_dev = hwmon_device_register(&new_client->dev);
447 if (IS_ERR(data->class_dev)) {
448 err = PTR_ERR(data->class_dev);
453 device_create_file(&new_client->dev, &dev_attr_fan1_input);
454 device_create_file(&new_client->dev, &dev_attr_fan1_min);
455 device_create_file(&new_client->dev, &dev_attr_fan1_div);
457 dev_dbg(&new_client->dev, "Fan 1 not enabled by hardware, "
461 device_create_file(&new_client->dev, &dev_attr_fan2_input);
462 device_create_file(&new_client->dev, &dev_attr_fan2_min);
463 device_create_file(&new_client->dev, &dev_attr_fan2_div);
465 dev_dbg(&new_client->dev, "Fan 2 not enabled by hardware, "
469 device_create_file(&new_client->dev, &dev_attr_pwm1);
470 device_create_file(&new_client->dev, &dev_attr_pwm1_enable);
472 dev_dbg(&new_client->dev, "PWM 1 not enabled by hardware, "
475 device_create_file(&new_client->dev, &dev_attr_pwm2);
476 device_create_file(&new_client->dev, &dev_attr_pwm2_enable);
478 dev_dbg(&new_client->dev, "PWM 2 not enabled by hardware, "
481 device_create_file(&new_client->dev, &dev_attr_alarms);
486 i2c_detach_client(new_client);
490 release_region(address, SMSC_EXTENT);
494 static int smsc47m1_detach_client(struct i2c_client *client)
496 struct smsc47m1_data *data = i2c_get_clientdata(client);
499 hwmon_device_unregister(data->class_dev);
501 if ((err = i2c_detach_client(client)))
504 release_region(client->addr, SMSC_EXTENT);
510 static int smsc47m1_read_value(struct i2c_client *client, u8 reg)
514 down(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
515 res = inb_p(client->addr + reg);
516 up(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
520 static void smsc47m1_write_value(struct i2c_client *client, u8 reg, u8 value)
522 down(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
523 outb_p(value, client->addr + reg);
524 up(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
527 static struct smsc47m1_data *smsc47m1_update_device(struct device *dev,
530 struct i2c_client *client = to_i2c_client(dev);
531 struct smsc47m1_data *data = i2c_get_clientdata(client);
533 down(&data->update_lock);
535 if (time_after(jiffies, data->last_updated + HZ + HZ / 2) || init) {
538 for (i = 0; i < 2; i++) {
539 data->fan[i] = smsc47m1_read_value(client,
540 SMSC47M1_REG_FAN(i));
541 data->fan_preload[i] = smsc47m1_read_value(client,
542 SMSC47M1_REG_FAN_PRELOAD(i));
543 data->pwm[i] = smsc47m1_read_value(client,
544 SMSC47M1_REG_PWM(i));
547 i = smsc47m1_read_value(client, SMSC47M1_REG_FANDIV);
548 data->fan_div[0] = (i >> 4) & 0x03;
549 data->fan_div[1] = i >> 6;
551 data->alarms = smsc47m1_read_value(client,
552 SMSC47M1_REG_ALARM) >> 6;
553 /* Clear alarms if needed */
555 smsc47m1_write_value(client, SMSC47M1_REG_ALARM, 0xC0);
557 data->last_updated = jiffies;
560 up(&data->update_lock);
564 static int __init sm_smsc47m1_init(void)
566 if (smsc47m1_find(&address)) {
570 return i2c_isa_add_driver(&smsc47m1_driver);
573 static void __exit sm_smsc47m1_exit(void)
575 i2c_isa_del_driver(&smsc47m1_driver);
578 MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>");
579 MODULE_DESCRIPTION("SMSC LPC47M1xx fan sensors driver");
580 MODULE_LICENSE("GPL");
582 module_init(sm_smsc47m1_init);
583 module_exit(sm_smsc47m1_exit);