2 smsc47m1.c - Part of lm_sensors, Linux kernel modules
3 for hardware monitoring
5 Supports the SMSC LPC47B27x, LPC47M10x, LPC47M13x and LPC47M14x
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/i2c.h>
32 #include <linux/i2c-sensor.h>
33 #include <linux/init.h>
36 static unsigned short normal_i2c[] = { I2C_CLIENT_END };
37 static unsigned short normal_i2c_range[] = { I2C_CLIENT_END };
38 /* Address is autodetected, there is no default value */
39 static unsigned int normal_isa[] = { 0x0000, I2C_CLIENT_ISA_END };
40 static unsigned int normal_isa_range[] = { I2C_CLIENT_ISA_END };
41 static struct i2c_force_data forces[] = {{NULL}};
43 enum chips { any_chip, smsc47m1 };
44 static struct i2c_address_data addr_data = {
45 .normal_i2c = normal_i2c,
46 .normal_i2c_range = normal_i2c_range,
47 .normal_isa = normal_isa,
48 .normal_isa_range = normal_isa_range,
49 .probe = normal_i2c, /* cheat */
50 .probe_range = normal_i2c_range, /* cheat */
51 .ignore = normal_i2c, /* cheat */
52 .ignore_range = normal_i2c_range, /* cheat */
56 /* Super-I/0 registers and commands */
58 #define REG 0x2e /* The register to read/write */
59 #define VAL 0x2f /* The value to read/write */
62 superio_outb(int reg, int val)
75 /* logical device for fans is 0x0A */
76 #define superio_select() superio_outb(0x07, 0x0A)
90 #define SUPERIO_REG_ACT 0x30
91 #define SUPERIO_REG_BASE 0x60
92 #define SUPERIO_REG_DEVID 0x20
94 /* Logical device registers */
96 #define SMSC_EXTENT 0x80
98 /* nr is 0 or 1 in the macros below */
99 #define SMSC47M1_REG_ALARM 0x04
100 #define SMSC47M1_REG_TPIN(nr) (0x34 - (nr))
101 #define SMSC47M1_REG_PPIN(nr) (0x36 - (nr))
102 #define SMSC47M1_REG_PWM(nr) (0x56 + (nr))
103 #define SMSC47M1_REG_FANDIV 0x58
104 #define SMSC47M1_REG_FAN(nr) (0x59 + (nr))
105 #define SMSC47M1_REG_FAN_PRELOAD(nr) (0x5B + (nr))
107 #define MIN_FROM_REG(reg,div) ((reg)>=192 ? 0 : \
108 983040/((192-(reg))*(div)))
109 #define FAN_FROM_REG(reg,div,preload) ((reg)<=(preload) || (reg)==255 ? 0 : \
110 983040/(((reg)-(preload))*(div)))
111 #define DIV_FROM_REG(reg) (1 << (reg))
112 #define PWM_FROM_REG(reg) (((reg) & 0x7E) << 1)
113 #define PWM_EN_FROM_REG(reg) ((~(reg)) & 0x01)
114 #define PWM_TO_REG(reg) (((reg) >> 1) & 0x7E)
116 struct smsc47m1_data {
117 struct i2c_client client;
118 struct semaphore lock;
121 struct semaphore update_lock;
122 unsigned long last_updated; /* In jiffies */
124 u8 fan[2]; /* Register value */
125 u8 fan_preload[2]; /* Register value */
126 u8 fan_div[2]; /* Register encoding, shifted right */
127 u8 alarms; /* Register encoding */
128 u8 pwm[2]; /* Register value (bit 7 is enable) */
132 static int smsc47m1_attach_adapter(struct i2c_adapter *adapter);
133 static int smsc47m1_find(int *address);
134 static int smsc47m1_detect(struct i2c_adapter *adapter, int address, int kind);
135 static int smsc47m1_detach_client(struct i2c_client *client);
137 static int smsc47m1_read_value(struct i2c_client *client, u8 reg);
138 static void smsc47m1_write_value(struct i2c_client *client, u8 reg, u8 value);
140 static struct smsc47m1_data *smsc47m1_update_device(struct device *dev,
144 static int smsc47m1_id;
146 static struct i2c_driver smsc47m1_driver = {
147 .owner = THIS_MODULE,
149 .id = I2C_DRIVERID_SMSC47M1,
150 .flags = I2C_DF_NOTIFY,
151 .attach_adapter = smsc47m1_attach_adapter,
152 .detach_client = smsc47m1_detach_client,
155 /* nr is 0 or 1 in the callback functions below */
157 static ssize_t get_fan(struct device *dev, char *buf, int nr)
159 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
160 /* This chip (stupidly) stops monitoring fan speed if PWM is
161 enabled and duty cycle is 0%. This is fine if the monitoring
162 and control concern the same fan, but troublesome if they are
163 not (which could as well happen). */
164 int rpm = (data->pwm[nr] & 0x7F) == 0x00 ? 0 :
165 FAN_FROM_REG(data->fan[nr],
166 DIV_FROM_REG(data->fan_div[nr]),
167 data->fan_preload[nr]);
168 return sprintf(buf, "%d\n", rpm);
171 static ssize_t get_fan_min(struct device *dev, char *buf, int nr)
173 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
174 int rpm = MIN_FROM_REG(data->fan_preload[nr],
175 DIV_FROM_REG(data->fan_div[nr]));
176 return sprintf(buf, "%d\n", rpm);
179 static ssize_t get_fan_div(struct device *dev, char *buf, int nr)
181 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
182 return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]));
185 static ssize_t get_fan_pwm(struct device *dev, char *buf, int nr)
187 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
188 return sprintf(buf, "%d\n", PWM_FROM_REG(data->pwm[nr]));
191 static ssize_t get_fan_pwm_en(struct device *dev, char *buf, int nr)
193 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
194 return sprintf(buf, "%d\n", PWM_EN_FROM_REG(data->pwm[nr]));
197 static ssize_t get_alarms(struct device *dev, char *buf)
199 struct smsc47m1_data *data = smsc47m1_update_device(dev, 0);
200 return sprintf(buf, "%d\n", data->alarms);
203 static ssize_t set_fan_min(struct device *dev, const char *buf,
204 size_t count, int nr)
206 struct i2c_client *client = to_i2c_client(dev);
207 struct smsc47m1_data *data = i2c_get_clientdata(client);
209 long rpmdiv = simple_strtol(buf, NULL, 10)
210 * DIV_FROM_REG(data->fan_div[nr]);
212 if (983040 > 192 * rpmdiv || 2 * rpmdiv > 983040)
215 data->fan_preload[nr] = 192 - ((983040 + rpmdiv / 2) / rpmdiv);
216 smsc47m1_write_value(client, SMSC47M1_REG_FAN_PRELOAD(nr),
217 data->fan_preload[nr]);
222 /* Note: we save and restore the fan minimum here, because its value is
223 determined in part by the fan clock divider. This follows the principle
224 of least suprise; the user doesn't expect the fan minimum to change just
225 because the divider changed. */
226 static ssize_t set_fan_div(struct device *dev, const char *buf,
227 size_t count, int nr)
229 struct i2c_client *client = to_i2c_client(dev);
230 struct smsc47m1_data *data = i2c_get_clientdata(client);
232 long new_div = simple_strtol(buf, NULL, 10), tmp;
233 u8 old_div = DIV_FROM_REG(data->fan_div[nr]);
235 if (new_div == old_div) /* No change */
238 case 1: data->fan_div[nr] = 0; break;
239 case 2: data->fan_div[nr] = 1; break;
240 case 4: data->fan_div[nr] = 2; break;
241 case 8: data->fan_div[nr] = 3; break;
242 default: return -EINVAL;
245 tmp = smsc47m1_read_value(client, SMSC47M1_REG_FANDIV) & 0x0F;
246 tmp |= (data->fan_div[0] << 4) | (data->fan_div[1] << 6);
247 smsc47m1_write_value(client, SMSC47M1_REG_FANDIV, tmp);
249 /* Preserve fan min */
250 tmp = 192 - (old_div * (192 - data->fan_preload[nr])
251 + new_div / 2) / new_div;
252 data->fan_preload[nr] = SENSORS_LIMIT(tmp, 0, 191);
253 smsc47m1_write_value(client, SMSC47M1_REG_FAN_PRELOAD(nr),
254 data->fan_preload[nr]);
259 static ssize_t set_fan_pwm(struct device *dev, const char *buf,
260 size_t count, int nr)
262 struct i2c_client *client = to_i2c_client(dev);
263 struct smsc47m1_data *data = i2c_get_clientdata(client);
265 long val = simple_strtol(buf, NULL, 10);
267 if (val < 0 || val > 255)
270 data->pwm[nr] &= 0x81; /* Preserve additional bits */
271 data->pwm[nr] |= PWM_TO_REG(val);
273 smsc47m1_write_value(client, SMSC47M1_REG_PWM(nr),
278 static ssize_t set_fan_pwm_en(struct device *dev, const char *buf,
279 size_t count, int nr)
281 struct i2c_client *client = to_i2c_client(dev);
282 struct smsc47m1_data *data = i2c_get_clientdata(client);
284 long val = simple_strtol(buf, NULL, 10);
286 if (val != 0 && val != 1)
289 data->pwm[nr] &= 0xFE; /* preserve the other bits */
290 data->pwm[nr] |= !val;
292 smsc47m1_write_value(client, SMSC47M1_REG_PWM(nr),
298 #define fan_present(offset) \
299 static ssize_t get_fan##offset (struct device *dev, char *buf) \
301 return get_fan(dev, buf, 0x##offset - 1); \
303 static ssize_t get_fan##offset##_min (struct device *dev, char *buf) \
305 return get_fan_min(dev, buf, 0x##offset - 1); \
307 static ssize_t set_fan##offset##_min (struct device *dev, \
308 const char *buf, size_t count) \
310 return set_fan_min(dev, buf, count, 0x##offset - 1); \
312 static ssize_t get_fan##offset##_div (struct device *dev, char *buf) \
314 return get_fan_div(dev, buf, 0x##offset - 1); \
316 static ssize_t set_fan##offset##_div (struct device *dev, \
317 const char *buf, size_t count) \
319 return set_fan_div(dev, buf, count, 0x##offset - 1); \
321 static ssize_t get_fan##offset##_pwm (struct device *dev, char *buf) \
323 return get_fan_pwm(dev, buf, 0x##offset - 1); \
325 static ssize_t set_fan##offset##_pwm (struct device *dev, \
326 const char *buf, size_t count) \
328 return set_fan_pwm(dev, buf, count, 0x##offset - 1); \
330 static ssize_t get_fan##offset##_pwm_en (struct device *dev, char *buf) \
332 return get_fan_pwm_en(dev, buf, 0x##offset - 1); \
334 static ssize_t set_fan##offset##_pwm_en (struct device *dev, \
335 const char *buf, size_t count) \
337 return set_fan_pwm_en(dev, buf, count, 0x##offset - 1); \
339 static DEVICE_ATTR(fan##offset##_input, S_IRUGO, get_fan##offset, \
341 static DEVICE_ATTR(fan##offset##_min, S_IRUGO | S_IWUSR, \
342 get_fan##offset##_min, set_fan##offset##_min); \
343 static DEVICE_ATTR(fan##offset##_div, S_IRUGO | S_IWUSR, \
344 get_fan##offset##_div, set_fan##offset##_div); \
345 static DEVICE_ATTR(fan##offset##_pwm, S_IRUGO | S_IWUSR, \
346 get_fan##offset##_pwm, set_fan##offset##_pwm); \
347 static DEVICE_ATTR(fan##offset##_pwm_enable, S_IRUGO | S_IWUSR, \
348 get_fan##offset##_pwm_en, set_fan##offset##_pwm_en);
353 static DEVICE_ATTR(alarms, S_IRUGO, get_alarms, NULL);
355 static int smsc47m1_attach_adapter(struct i2c_adapter *adapter)
357 if (!(adapter->class & I2C_CLASS_HWMON))
359 return i2c_detect(adapter, &addr_data, smsc47m1_detect);
362 static int smsc47m1_find(int *address)
367 val = superio_inb(SUPERIO_REG_DEVID);
370 * SMSC LPC47M10x/LPC47M13x (device id 0x59), LPC47M14x (device id
371 * 0x5F) and LPC47B27x (device id 0x51) have fan control.
372 * The LPC47M15x and LPC47M192 chips "with hardware monitoring block"
373 * can do much more besides (device id 0x60, unsupported).
376 printk(KERN_INFO "smsc47m1: Found SMSC47B27x\n");
377 else if (val == 0x59)
378 printk(KERN_INFO "smsc47m1: Found SMSC47M10x/SMSC47M13x\n");
379 else if (val == 0x5F)
380 printk(KERN_INFO "smsc47m1: Found SMSC47M14x\n");
387 *address = (superio_inb(SUPERIO_REG_BASE) << 8)
388 | superio_inb(SUPERIO_REG_BASE + 1);
389 val = superio_inb(SUPERIO_REG_ACT);
390 if (*address == 0 || (val & 0x01) == 0) {
391 printk(KERN_INFO "smsc47m1: Device is disabled, will not use\n");
400 static int smsc47m1_detect(struct i2c_adapter *adapter, int address, int kind)
402 struct i2c_client *new_client;
403 struct smsc47m1_data *data;
406 if (!i2c_is_isa_adapter(adapter)) {
410 if (!request_region(address, SMSC_EXTENT, "smsc47m1")) {
411 dev_err(&adapter->dev, "Region 0x%x already in use!\n", address);
415 if (!(data = kmalloc(sizeof(struct smsc47m1_data), GFP_KERNEL))) {
419 memset(data, 0x00, sizeof(struct smsc47m1_data));
421 new_client = &data->client;
422 i2c_set_clientdata(new_client, data);
423 new_client->addr = address;
424 init_MUTEX(&data->lock);
425 new_client->adapter = adapter;
426 new_client->driver = &smsc47m1_driver;
427 new_client->flags = 0;
429 strlcpy(new_client->name, "smsc47m1", I2C_NAME_SIZE);
431 new_client->id = smsc47m1_id++;
432 init_MUTEX(&data->update_lock);
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 if ((smsc47m1_read_value(new_client, SMSC47M1_REG_TPIN(0)) & 0x05)
447 device_create_file(&new_client->dev, &dev_attr_fan1_input);
448 device_create_file(&new_client->dev, &dev_attr_fan1_min);
449 device_create_file(&new_client->dev, &dev_attr_fan1_div);
451 dev_dbg(&new_client->dev, "Fan 1 not enabled by hardware, "
454 if ((smsc47m1_read_value(new_client, SMSC47M1_REG_TPIN(1)) & 0x05)
456 device_create_file(&new_client->dev, &dev_attr_fan2_input);
457 device_create_file(&new_client->dev, &dev_attr_fan2_min);
458 device_create_file(&new_client->dev, &dev_attr_fan2_div);
460 dev_dbg(&new_client->dev, "Fan 2 not enabled by hardware, "
463 if ((smsc47m1_read_value(new_client, SMSC47M1_REG_PPIN(0)) & 0x05)
465 device_create_file(&new_client->dev, &dev_attr_fan1_pwm);
466 device_create_file(&new_client->dev, &dev_attr_fan1_pwm_enable);
468 dev_dbg(&new_client->dev, "PWM 1 not enabled by hardware, "
470 if ((smsc47m1_read_value(new_client, SMSC47M1_REG_PPIN(1)) & 0x05)
472 device_create_file(&new_client->dev, &dev_attr_fan2_pwm);
473 device_create_file(&new_client->dev, &dev_attr_fan2_pwm_enable);
475 dev_dbg(&new_client->dev, "PWM 2 not enabled by hardware, "
478 device_create_file(&new_client->dev, &dev_attr_alarms);
485 release_region(address, SMSC_EXTENT);
489 static int smsc47m1_detach_client(struct i2c_client *client)
493 if ((err = i2c_detach_client(client))) {
494 dev_err(&client->dev, "Client deregistration failed, "
495 "client not detached.\n");
499 release_region(client->addr, SMSC_EXTENT);
500 kfree(i2c_get_clientdata(client));
505 static int smsc47m1_read_value(struct i2c_client *client, u8 reg)
509 down(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
510 res = inb_p(client->addr + reg);
511 up(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
515 static void smsc47m1_write_value(struct i2c_client *client, u8 reg, u8 value)
517 down(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
518 outb_p(value, client->addr + reg);
519 up(&((struct smsc47m1_data *) i2c_get_clientdata(client))->lock);
522 static struct smsc47m1_data *smsc47m1_update_device(struct device *dev,
525 struct i2c_client *client = to_i2c_client(dev);
526 struct smsc47m1_data *data = i2c_get_clientdata(client);
528 down(&data->update_lock);
530 if ((jiffies - data->last_updated > HZ + HZ / 2) ||
531 (jiffies < data->last_updated) || init) {
534 for (i = 0; i < 2; i++) {
535 data->fan[i] = smsc47m1_read_value(client,
536 SMSC47M1_REG_FAN(i));
537 data->fan_preload[i] = smsc47m1_read_value(client,
538 SMSC47M1_REG_FAN_PRELOAD(i));
539 data->pwm[i] = smsc47m1_read_value(client,
540 SMSC47M1_REG_PWM(i));
543 i = smsc47m1_read_value(client, SMSC47M1_REG_FANDIV);
544 data->fan_div[0] = (i >> 4) & 0x03;
545 data->fan_div[1] = i >> 6;
547 data->alarms = smsc47m1_read_value(client,
548 SMSC47M1_REG_ALARM) >> 6;
549 /* Clear alarms if needed */
551 smsc47m1_write_value(client, SMSC47M1_REG_ALARM, 0xC0);
553 data->last_updated = jiffies;
556 up(&data->update_lock);
560 static int __init sm_smsc47m1_init(void)
562 if (smsc47m1_find(normal_isa)) {
566 return i2c_add_driver(&smsc47m1_driver);
569 static void __exit sm_smsc47m1_exit(void)
571 i2c_del_driver(&smsc47m1_driver);
574 MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>");
575 MODULE_DESCRIPTION("SMSC LPC47M1xx fan sensors driver");
576 MODULE_LICENSE("GPL");
578 module_init(sm_smsc47m1_init);
579 module_exit(sm_smsc47m1_exit);