2 fscpos.c - Kernel module for hardware monitoring with FSC Poseidon chips
3 Copyright (C) 2004, 2005 Stefan Ott <stefan@desire.ch>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 fujitsu siemens poseidon chip,
22 module based on the old fscpos module by Hermann Jung <hej@odn.de> and
23 the fscher module by Reinhard Nissl <rnissl@gmx.de>
25 original module based on lm80.c
26 Copyright (C) 1998, 1999 Frodo Looijaard <frodol@dds.nl>
27 and Philip Edelbrock <phil@netroedge.com>
29 Thanks to Jean Delvare for reviewing my code and suggesting a lot of
33 #include <linux/module.h>
34 #include <linux/slab.h>
35 #include <linux/jiffies.h>
36 #include <linux/i2c.h>
37 #include <linux/i2c-sensor.h>
38 #include <linux/init.h>
43 static unsigned short normal_i2c[] = { 0x73, I2C_CLIENT_END };
44 static unsigned int normal_isa[] = { I2C_CLIENT_ISA_END };
49 SENSORS_INSMOD_1(fscpos);
52 * The FSCPOS registers
55 /* chip identification */
56 #define FSCPOS_REG_IDENT_0 0x00
57 #define FSCPOS_REG_IDENT_1 0x01
58 #define FSCPOS_REG_IDENT_2 0x02
59 #define FSCPOS_REG_REVISION 0x03
61 /* global control and status */
62 #define FSCPOS_REG_EVENT_STATE 0x04
63 #define FSCPOS_REG_CONTROL 0x05
66 #define FSCPOS_REG_WDOG_PRESET 0x28
67 #define FSCPOS_REG_WDOG_STATE 0x23
68 #define FSCPOS_REG_WDOG_CONTROL 0x21
71 #define FSCPOS_REG_VOLT_12 0x45
72 #define FSCPOS_REG_VOLT_5 0x42
73 #define FSCPOS_REG_VOLT_BATT 0x48
75 /* fans - the chip does not support minimum speed for fan2 */
76 static u8 FSCPOS_REG_PWM[] = { 0x55, 0x65 };
77 static u8 FSCPOS_REG_FAN_ACT[] = { 0x0e, 0x6b, 0xab };
78 static u8 FSCPOS_REG_FAN_STATE[] = { 0x0d, 0x62, 0xa2 };
79 static u8 FSCPOS_REG_FAN_RIPPLE[] = { 0x0f, 0x6f, 0xaf };
82 static u8 FSCPOS_REG_TEMP_ACT[] = { 0x64, 0x32, 0x35 };
83 static u8 FSCPOS_REG_TEMP_STATE[] = { 0x71, 0x81, 0x91 };
86 * Functions declaration
88 static int fscpos_attach_adapter(struct i2c_adapter *adapter);
89 static int fscpos_detect(struct i2c_adapter *adapter, int address, int kind);
90 static int fscpos_detach_client(struct i2c_client *client);
92 static int fscpos_read_value(struct i2c_client *client, u8 register);
93 static int fscpos_write_value(struct i2c_client *client, u8 register, u8 value);
94 static struct fscpos_data *fscpos_update_device(struct device *dev);
95 static void fscpos_init_client(struct i2c_client *client);
97 static void reset_fan_alarm(struct i2c_client *client, int nr);
100 * Driver data (common to all clients)
102 static struct i2c_driver fscpos_driver = {
103 .owner = THIS_MODULE,
105 .id = I2C_DRIVERID_FSCPOS,
106 .flags = I2C_DF_NOTIFY,
107 .attach_adapter = fscpos_attach_adapter,
108 .detach_client = fscpos_detach_client,
112 * Client data (each client gets its own)
115 struct i2c_client client;
116 struct semaphore update_lock;
117 char valid; /* 0 until following fields are valid */
118 unsigned long last_updated; /* In jiffies */
120 /* register values */
121 u8 revision; /* revision of chip */
122 u8 global_event; /* global event status */
123 u8 global_control; /* global control register */
124 u8 wdog_control; /* watchdog control */
125 u8 wdog_state; /* watchdog status */
126 u8 wdog_preset; /* watchdog preset */
127 u8 volt[3]; /* 12, 5, battery current */
128 u8 temp_act[3]; /* temperature */
129 u8 temp_status[3]; /* status of sensor */
130 u8 fan_act[3]; /* fans revolutions per second */
131 u8 fan_status[3]; /* fan status */
132 u8 pwm[2]; /* fan min value for rps */
133 u8 fan_ripple[3]; /* divider for rps */
137 #define TEMP_FROM_REG(val) (((val) - 128) * 1000)
139 static ssize_t show_temp_input(struct fscpos_data *data, char *buf, int nr)
141 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_act[nr - 1]));
144 static ssize_t show_temp_status(struct fscpos_data *data, char *buf, int nr)
146 /* bits 2..7 reserved => mask with 0x03 */
147 return sprintf(buf, "%u\n", data->temp_status[nr - 1] & 0x03);
150 static ssize_t show_temp_reset(struct fscpos_data *data, char *buf, int nr)
152 return sprintf(buf, "1\n");
155 static ssize_t set_temp_reset(struct i2c_client *client, struct fscpos_data
156 *data, const char *buf, size_t count, int nr, int reg)
158 unsigned long v = simple_strtoul(buf, NULL, 10);
160 dev_err(&client->dev, "temp_reset value %ld not supported. "
161 "Use 1 to reset the alarm!\n", v);
165 dev_info(&client->dev, "You used the temp_reset feature which has not "
166 "been proplerly tested. Please report your "
167 "experience to the module author.\n");
169 /* Supported value: 2 (clears the status) */
170 fscpos_write_value(client, FSCPOS_REG_TEMP_STATE[nr - 1], 2);
175 #define RPM_FROM_REG(val) ((val) * 60)
177 static ssize_t show_fan_status(struct fscpos_data *data, char *buf, int nr)
179 /* bits 0..1, 3..7 reserved => mask with 0x04 */
180 return sprintf(buf, "%u\n", data->fan_status[nr - 1] & 0x04);
183 static ssize_t show_fan_input(struct fscpos_data *data, char *buf, int nr)
185 return sprintf(buf, "%u\n", RPM_FROM_REG(data->fan_act[nr - 1]));
188 static ssize_t show_fan_ripple(struct fscpos_data *data, char *buf, int nr)
190 /* bits 2..7 reserved => mask with 0x03 */
191 return sprintf(buf, "%u\n", data->fan_ripple[nr - 1] & 0x03);
194 static ssize_t set_fan_ripple(struct i2c_client *client, struct fscpos_data
195 *data, const char *buf, size_t count, int nr, int reg)
197 /* supported values: 2, 4, 8 */
198 unsigned long v = simple_strtoul(buf, NULL, 10);
201 case 2: v = 1; break;
202 case 4: v = 2; break;
203 case 8: v = 3; break;
205 dev_err(&client->dev, "fan_ripple value %ld not supported. "
206 "Must be one of 2, 4 or 8!\n", v);
210 down(&data->update_lock);
211 /* bits 2..7 reserved => mask with 0x03 */
212 data->fan_ripple[nr - 1] &= ~0x03;
213 data->fan_ripple[nr - 1] |= v;
215 fscpos_write_value(client, reg, data->fan_ripple[nr - 1]);
216 up(&data->update_lock);
220 static ssize_t show_pwm(struct fscpos_data *data, char *buf, int nr)
222 return sprintf(buf, "%u\n", data->pwm[nr - 1]);
225 static ssize_t set_pwm(struct i2c_client *client, struct fscpos_data *data,
226 const char *buf, size_t count, int nr, int reg)
228 unsigned long v = simple_strtoul(buf, NULL, 10);
232 if (v > 255) v = 255;
234 down(&data->update_lock);
235 data->pwm[nr - 1] = v;
236 fscpos_write_value(client, reg, data->pwm[nr - 1]);
237 up(&data->update_lock);
241 static void reset_fan_alarm(struct i2c_client *client, int nr)
243 fscpos_write_value(client, FSCPOS_REG_FAN_STATE[nr], 4);
247 #define VOLT_FROM_REG(val, mult) ((val) * (mult) / 255)
249 static ssize_t show_volt_12(struct device *dev, struct device_attribute *attr, char *buf)
251 struct fscpos_data *data = fscpos_update_device(dev);
252 return sprintf(buf, "%u\n", VOLT_FROM_REG(data->volt[0], 14200));
255 static ssize_t show_volt_5(struct device *dev, struct device_attribute *attr, char *buf)
257 struct fscpos_data *data = fscpos_update_device(dev);
258 return sprintf(buf, "%u\n", VOLT_FROM_REG(data->volt[1], 6600));
261 static ssize_t show_volt_batt(struct device *dev, struct device_attribute *attr, char *buf)
263 struct fscpos_data *data = fscpos_update_device(dev);
264 return sprintf(buf, "%u\n", VOLT_FROM_REG(data->volt[2], 3300));
268 static ssize_t show_wdog_control(struct fscpos_data *data, char *buf)
270 /* bits 0..3 reserved, bit 6 write only => mask with 0xb0 */
271 return sprintf(buf, "%u\n", data->wdog_control & 0xb0);
274 static ssize_t set_wdog_control(struct i2c_client *client, struct fscpos_data
275 *data, const char *buf, size_t count, int reg)
277 /* bits 0..3 reserved => mask with 0xf0 */
278 unsigned long v = simple_strtoul(buf, NULL, 10) & 0xf0;
280 down(&data->update_lock);
281 data->wdog_control &= ~0xf0;
282 data->wdog_control |= v;
283 fscpos_write_value(client, reg, data->wdog_control);
284 up(&data->update_lock);
288 static ssize_t show_wdog_state(struct fscpos_data *data, char *buf)
290 /* bits 0, 2..7 reserved => mask with 0x02 */
291 return sprintf(buf, "%u\n", data->wdog_state & 0x02);
294 static ssize_t set_wdog_state(struct i2c_client *client, struct fscpos_data
295 *data, const char *buf, size_t count, int reg)
297 unsigned long v = simple_strtoul(buf, NULL, 10) & 0x02;
299 /* Valid values: 2 (clear) */
301 dev_err(&client->dev, "wdog_state value %ld not supported. "
302 "Must be 2 to clear the state!\n", v);
306 down(&data->update_lock);
307 data->wdog_state &= ~v;
308 fscpos_write_value(client, reg, v);
309 up(&data->update_lock);
313 static ssize_t show_wdog_preset(struct fscpos_data *data, char *buf)
315 return sprintf(buf, "%u\n", data->wdog_preset);
318 static ssize_t set_wdog_preset(struct i2c_client *client, struct fscpos_data
319 *data, const char *buf, size_t count, int reg)
321 unsigned long v = simple_strtoul(buf, NULL, 10) & 0xff;
323 down(&data->update_lock);
324 data->wdog_preset = v;
325 fscpos_write_value(client, reg, data->wdog_preset);
326 up(&data->update_lock);
331 static ssize_t show_event(struct device *dev, struct device_attribute *attr, char *buf)
333 /* bits 5..7 reserved => mask with 0x1f */
334 struct fscpos_data *data = fscpos_update_device(dev);
335 return sprintf(buf, "%u\n", data->global_event & 0x9b);
341 #define create_getter(kind, sub) \
342 static ssize_t sysfs_show_##kind##sub(struct device *dev, struct device_attribute *attr, char *buf) \
344 struct fscpos_data *data = fscpos_update_device(dev); \
345 return show_##kind##sub(data, buf); \
348 #define create_getter_n(kind, offset, sub) \
349 static ssize_t sysfs_show_##kind##offset##sub(struct device *dev, struct device_attribute *attr, char\
352 struct fscpos_data *data = fscpos_update_device(dev); \
353 return show_##kind##sub(data, buf, offset); \
356 #define create_setter(kind, sub, reg) \
357 static ssize_t sysfs_set_##kind##sub (struct device *dev, struct device_attribute *attr, const char \
358 *buf, size_t count) \
360 struct i2c_client *client = to_i2c_client(dev); \
361 struct fscpos_data *data = i2c_get_clientdata(client); \
362 return set_##kind##sub(client, data, buf, count, reg); \
365 #define create_setter_n(kind, offset, sub, reg) \
366 static ssize_t sysfs_set_##kind##offset##sub (struct device *dev, struct device_attribute *attr, \
367 const char *buf, size_t count) \
369 struct i2c_client *client = to_i2c_client(dev); \
370 struct fscpos_data *data = i2c_get_clientdata(client); \
371 return set_##kind##sub(client, data, buf, count, offset, reg);\
374 #define create_sysfs_device_ro(kind, sub, offset) \
375 static DEVICE_ATTR(kind##offset##sub, S_IRUGO, \
376 sysfs_show_##kind##offset##sub, NULL);
378 #define create_sysfs_device_rw(kind, sub, offset) \
379 static DEVICE_ATTR(kind##offset##sub, S_IRUGO | S_IWUSR, \
380 sysfs_show_##kind##offset##sub, sysfs_set_##kind##offset##sub);
382 #define sysfs_ro_n(kind, sub, offset) \
383 create_getter_n(kind, offset, sub); \
384 create_sysfs_device_ro(kind, sub, offset);
386 #define sysfs_rw_n(kind, sub, offset, reg) \
387 create_getter_n(kind, offset, sub); \
388 create_setter_n(kind, offset, sub, reg); \
389 create_sysfs_device_rw(kind, sub, offset);
391 #define sysfs_rw(kind, sub, reg) \
392 create_getter(kind, sub); \
393 create_setter(kind, sub, reg); \
394 create_sysfs_device_rw(kind, sub,);
396 #define sysfs_fan_with_min(offset, reg_status, reg_ripple, reg_min) \
397 sysfs_fan(offset, reg_status, reg_ripple); \
398 sysfs_rw_n(pwm,, offset, reg_min);
400 #define sysfs_fan(offset, reg_status, reg_ripple) \
401 sysfs_ro_n(fan, _input, offset); \
402 sysfs_ro_n(fan, _status, offset); \
403 sysfs_rw_n(fan, _ripple, offset, reg_ripple);
405 #define sysfs_temp(offset, reg_status) \
406 sysfs_ro_n(temp, _input, offset); \
407 sysfs_ro_n(temp, _status, offset); \
408 sysfs_rw_n(temp, _reset, offset, reg_status);
410 #define sysfs_watchdog(reg_wdog_preset, reg_wdog_state, reg_wdog_control) \
411 sysfs_rw(wdog, _control, reg_wdog_control); \
412 sysfs_rw(wdog, _preset, reg_wdog_preset); \
413 sysfs_rw(wdog, _state, reg_wdog_state);
415 sysfs_fan_with_min(1, FSCPOS_REG_FAN_STATE[0], FSCPOS_REG_FAN_RIPPLE[0],
417 sysfs_fan_with_min(2, FSCPOS_REG_FAN_STATE[1], FSCPOS_REG_FAN_RIPPLE[1],
419 sysfs_fan(3, FSCPOS_REG_FAN_STATE[2], FSCPOS_REG_FAN_RIPPLE[2]);
421 sysfs_temp(1, FSCPOS_REG_TEMP_STATE[0]);
422 sysfs_temp(2, FSCPOS_REG_TEMP_STATE[1]);
423 sysfs_temp(3, FSCPOS_REG_TEMP_STATE[2]);
425 sysfs_watchdog(FSCPOS_REG_WDOG_PRESET, FSCPOS_REG_WDOG_STATE,
426 FSCPOS_REG_WDOG_CONTROL);
428 static DEVICE_ATTR(event, S_IRUGO, show_event, NULL);
429 static DEVICE_ATTR(in0_input, S_IRUGO, show_volt_12, NULL);
430 static DEVICE_ATTR(in1_input, S_IRUGO, show_volt_5, NULL);
431 static DEVICE_ATTR(in2_input, S_IRUGO, show_volt_batt, NULL);
433 static int fscpos_attach_adapter(struct i2c_adapter *adapter)
435 if (!(adapter->class & I2C_CLASS_HWMON))
437 return i2c_detect(adapter, &addr_data, fscpos_detect);
440 int fscpos_detect(struct i2c_adapter *adapter, int address, int kind)
442 struct i2c_client *new_client;
443 struct fscpos_data *data;
446 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
450 * OK. For now, we presume we have a valid client. We now create the
451 * client structure, even though we cannot fill it completely yet.
452 * But it allows us to access fscpos_{read,write}_value.
455 if (!(data = kmalloc(sizeof(struct fscpos_data), GFP_KERNEL))) {
459 memset(data, 0, sizeof(struct fscpos_data));
461 new_client = &data->client;
462 i2c_set_clientdata(new_client, data);
463 new_client->addr = address;
464 new_client->adapter = adapter;
465 new_client->driver = &fscpos_driver;
466 new_client->flags = 0;
468 /* Do the remaining detection unless force or force_fscpos parameter */
470 if ((fscpos_read_value(new_client, FSCPOS_REG_IDENT_0)
472 || (fscpos_read_value(new_client, FSCPOS_REG_IDENT_1)
474 || (fscpos_read_value(new_client, FSCPOS_REG_IDENT_2)
477 dev_dbg(&new_client->dev, "fscpos detection failed\n");
482 /* Fill in the remaining client fields and put it in the global list */
483 strlcpy(new_client->name, "fscpos", I2C_NAME_SIZE);
486 init_MUTEX(&data->update_lock);
488 /* Tell the I2C layer a new client has arrived */
489 if ((err = i2c_attach_client(new_client)))
492 /* Inizialize the fscpos chip */
493 fscpos_init_client(new_client);
495 /* Announce that the chip was found */
496 dev_info(&new_client->dev, "Found fscpos chip, rev %u\n", data->revision);
498 /* Register sysfs hooks */
499 device_create_file(&new_client->dev, &dev_attr_event);
500 device_create_file(&new_client->dev, &dev_attr_in0_input);
501 device_create_file(&new_client->dev, &dev_attr_in1_input);
502 device_create_file(&new_client->dev, &dev_attr_in2_input);
503 device_create_file(&new_client->dev, &dev_attr_wdog_control);
504 device_create_file(&new_client->dev, &dev_attr_wdog_preset);
505 device_create_file(&new_client->dev, &dev_attr_wdog_state);
506 device_create_file(&new_client->dev, &dev_attr_temp1_input);
507 device_create_file(&new_client->dev, &dev_attr_temp1_status);
508 device_create_file(&new_client->dev, &dev_attr_temp1_reset);
509 device_create_file(&new_client->dev, &dev_attr_temp2_input);
510 device_create_file(&new_client->dev, &dev_attr_temp2_status);
511 device_create_file(&new_client->dev, &dev_attr_temp2_reset);
512 device_create_file(&new_client->dev, &dev_attr_temp3_input);
513 device_create_file(&new_client->dev, &dev_attr_temp3_status);
514 device_create_file(&new_client->dev, &dev_attr_temp3_reset);
515 device_create_file(&new_client->dev, &dev_attr_fan1_input);
516 device_create_file(&new_client->dev, &dev_attr_fan1_status);
517 device_create_file(&new_client->dev, &dev_attr_fan1_ripple);
518 device_create_file(&new_client->dev, &dev_attr_pwm1);
519 device_create_file(&new_client->dev, &dev_attr_fan2_input);
520 device_create_file(&new_client->dev, &dev_attr_fan2_status);
521 device_create_file(&new_client->dev, &dev_attr_fan2_ripple);
522 device_create_file(&new_client->dev, &dev_attr_pwm2);
523 device_create_file(&new_client->dev, &dev_attr_fan3_input);
524 device_create_file(&new_client->dev, &dev_attr_fan3_status);
525 device_create_file(&new_client->dev, &dev_attr_fan3_ripple);
535 static int fscpos_detach_client(struct i2c_client *client)
539 if ((err = i2c_detach_client(client))) {
540 dev_err(&client->dev, "Client deregistration failed, client"
544 kfree(i2c_get_clientdata(client));
548 static int fscpos_read_value(struct i2c_client *client, u8 reg)
550 dev_dbg(&client->dev, "Read reg 0x%02x\n", reg);
551 return i2c_smbus_read_byte_data(client, reg);
554 static int fscpos_write_value(struct i2c_client *client, u8 reg, u8 value)
556 dev_dbg(&client->dev, "Write reg 0x%02x, val 0x%02x\n", reg, value);
557 return i2c_smbus_write_byte_data(client, reg, value);
560 /* Called when we have found a new FSCPOS chip */
561 static void fscpos_init_client(struct i2c_client *client)
563 struct fscpos_data *data = i2c_get_clientdata(client);
565 /* read revision from chip */
566 data->revision = fscpos_read_value(client, FSCPOS_REG_REVISION);
569 static struct fscpos_data *fscpos_update_device(struct device *dev)
571 struct i2c_client *client = to_i2c_client(dev);
572 struct fscpos_data *data = i2c_get_clientdata(client);
574 down(&data->update_lock);
576 if (time_after(jiffies, data->last_updated + 2 * HZ) || !data->valid) {
579 dev_dbg(&client->dev, "Starting fscpos update\n");
581 for (i = 0; i < 3; i++) {
582 data->temp_act[i] = fscpos_read_value(client,
583 FSCPOS_REG_TEMP_ACT[i]);
584 data->temp_status[i] = fscpos_read_value(client,
585 FSCPOS_REG_TEMP_STATE[i]);
586 data->fan_act[i] = fscpos_read_value(client,
587 FSCPOS_REG_FAN_ACT[i]);
588 data->fan_status[i] = fscpos_read_value(client,
589 FSCPOS_REG_FAN_STATE[i]);
590 data->fan_ripple[i] = fscpos_read_value(client,
591 FSCPOS_REG_FAN_RIPPLE[i]);
593 /* fan2_min is not supported by the chip */
594 data->pwm[i] = fscpos_read_value(client,
597 /* reset fan status if speed is back to > 0 */
598 if (data->fan_status[i] != 0 && data->fan_act[i] > 0) {
599 reset_fan_alarm(client, i);
603 data->volt[0] = fscpos_read_value(client, FSCPOS_REG_VOLT_12);
604 data->volt[1] = fscpos_read_value(client, FSCPOS_REG_VOLT_5);
605 data->volt[2] = fscpos_read_value(client, FSCPOS_REG_VOLT_BATT);
607 data->wdog_preset = fscpos_read_value(client,
608 FSCPOS_REG_WDOG_PRESET);
609 data->wdog_state = fscpos_read_value(client,
610 FSCPOS_REG_WDOG_STATE);
611 data->wdog_control = fscpos_read_value(client,
612 FSCPOS_REG_WDOG_CONTROL);
614 data->global_event = fscpos_read_value(client,
615 FSCPOS_REG_EVENT_STATE);
617 data->last_updated = jiffies;
620 up(&data->update_lock);
624 static int __init sm_fscpos_init(void)
626 return i2c_add_driver(&fscpos_driver);
629 static void __exit sm_fscpos_exit(void)
631 i2c_del_driver(&fscpos_driver);
634 MODULE_AUTHOR("Stefan Ott <stefan@desire.ch> based on work from Hermann Jung "
635 "<hej@odn.de>, Frodo Looijaard <frodol@dds.nl>"
636 " and Philip Edelbrock <phil@netroedge.com>");
637 MODULE_DESCRIPTION("fujitsu siemens poseidon chip driver");
638 MODULE_LICENSE("GPL");
640 module_init(sm_fscpos_init);
641 module_exit(sm_fscpos_exit);