d7df0e6c1ef4afd3e096d7ac81f0492fbf28adc7
[linux-2.6.git] / drivers / hwmon / pcf8591.c
1 /*
2     Copyright (C) 2001-2004 Aurelien Jarno <aurelien@aurel32.net>
3     Ported to Linux 2.6 by Aurelien Jarno <aurelien@aurel32.net> with
4     the help of Jean Delvare <khali@linux-fr.org>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/slab.h>
24 #include <linux/i2c.h>
25 #include <linux/mutex.h>
26 #include <linux/err.h>
27 #include <linux/hwmon.h>
28
29 /* Addresses to scan */
30 static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, 0x4c,
31                                         0x4d, 0x4e, 0x4f, I2C_CLIENT_END };
32
33 /* Insmod parameters */
34
35 static int input_mode;
36 module_param(input_mode, int, 0);
37 MODULE_PARM_DESC(input_mode,
38         "Analog input mode:\n"
39         " 0 = four single ended inputs\n"
40         " 1 = three differential inputs\n"
41         " 2 = single ended and differential mixed\n"
42         " 3 = two differential inputs\n");
43
44 /* The PCF8591 control byte
45       7    6    5    4    3    2    1    0
46    |  0 |AOEF|   AIP   |  0 |AINC|  AICH   | */
47
48 /* Analog Output Enable Flag (analog output active if 1) */
49 #define PCF8591_CONTROL_AOEF            0x40
50
51 /* Analog Input Programming
52    0x00 = four single ended inputs
53    0x10 = three differential inputs
54    0x20 = single ended and differential mixed
55    0x30 = two differential inputs */
56 #define PCF8591_CONTROL_AIP_MASK        0x30
57
58 /* Autoincrement Flag (switch on if 1) */
59 #define PCF8591_CONTROL_AINC            0x04
60
61 /* Channel selection
62    0x00 = channel 0
63    0x01 = channel 1
64    0x02 = channel 2
65    0x03 = channel 3 */
66 #define PCF8591_CONTROL_AICH_MASK       0x03
67
68 /* Initial values */
69 #define PCF8591_INIT_CONTROL    ((input_mode << 4) | PCF8591_CONTROL_AOEF)
70 #define PCF8591_INIT_AOUT       0       /* DAC out = 0 */
71
72 /* Conversions */
73 #define REG_TO_SIGNED(reg)      (((reg) & 0x80)?((reg) - 256):(reg))
74
75 struct pcf8591_data {
76         struct device *hwmon_dev;
77         struct mutex update_lock;
78
79         u8 control;
80         u8 aout;
81 };
82
83 static void pcf8591_init_client(struct i2c_client *client);
84 static int pcf8591_read_channel(struct device *dev, int channel);
85
86 /* following are the sysfs callback functions */
87 #define show_in_channel(channel)                                        \
88 static ssize_t show_in##channel##_input(struct device *dev, struct device_attribute *attr, char *buf)   \
89 {                                                                       \
90         return sprintf(buf, "%d\n", pcf8591_read_channel(dev, channel));\
91 }                                                                       \
92 static DEVICE_ATTR(in##channel##_input, S_IRUGO,                        \
93                    show_in##channel##_input, NULL);
94
95 show_in_channel(0);
96 show_in_channel(1);
97 show_in_channel(2);
98 show_in_channel(3);
99
100 static ssize_t show_out0_ouput(struct device *dev, struct device_attribute *attr, char *buf)
101 {
102         struct pcf8591_data *data = i2c_get_clientdata(to_i2c_client(dev));
103         return sprintf(buf, "%d\n", data->aout * 10);
104 }
105
106 static ssize_t set_out0_output(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
107 {
108         unsigned int value;
109         struct i2c_client *client = to_i2c_client(dev);
110         struct pcf8591_data *data = i2c_get_clientdata(client);
111         if ((value = (simple_strtoul(buf, NULL, 10) + 5) / 10) <= 255) {
112                 data->aout = value;
113                 i2c_smbus_write_byte_data(client, data->control, data->aout);
114                 return count;
115         }
116         return -EINVAL;
117 }
118
119 static DEVICE_ATTR(out0_output, S_IWUSR | S_IRUGO,
120                    show_out0_ouput, set_out0_output);
121
122 static ssize_t show_out0_enable(struct device *dev, struct device_attribute *attr, char *buf)
123 {
124         struct pcf8591_data *data = i2c_get_clientdata(to_i2c_client(dev));
125         return sprintf(buf, "%u\n", !(!(data->control & PCF8591_CONTROL_AOEF)));
126 }
127
128 static ssize_t set_out0_enable(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
129 {
130         struct i2c_client *client = to_i2c_client(dev);
131         struct pcf8591_data *data = i2c_get_clientdata(client);
132         unsigned long val = simple_strtoul(buf, NULL, 10);
133
134         mutex_lock(&data->update_lock);
135         if (val)
136                 data->control |= PCF8591_CONTROL_AOEF;
137         else
138                 data->control &= ~PCF8591_CONTROL_AOEF;
139         i2c_smbus_write_byte(client, data->control);
140         mutex_unlock(&data->update_lock);
141         return count;
142 }
143
144 static DEVICE_ATTR(out0_enable, S_IWUSR | S_IRUGO,
145                    show_out0_enable, set_out0_enable);
146
147 static struct attribute *pcf8591_attributes[] = {
148         &dev_attr_out0_enable.attr,
149         &dev_attr_out0_output.attr,
150         &dev_attr_in0_input.attr,
151         &dev_attr_in1_input.attr,
152         NULL
153 };
154
155 static const struct attribute_group pcf8591_attr_group = {
156         .attrs = pcf8591_attributes,
157 };
158
159 static struct attribute *pcf8591_attributes_opt[] = {
160         &dev_attr_in2_input.attr,
161         &dev_attr_in3_input.attr,
162         NULL
163 };
164
165 static const struct attribute_group pcf8591_attr_group_opt = {
166         .attrs = pcf8591_attributes_opt,
167 };
168
169 /*
170  * Real code
171  */
172
173 /* Return 0 if detection is successful, -ENODEV otherwise */
174 static int pcf8591_detect(struct i2c_client *client,
175                           struct i2c_board_info *info)
176 {
177         struct i2c_adapter *adapter = client->adapter;
178
179         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE
180                                      | I2C_FUNC_SMBUS_WRITE_BYTE_DATA))
181                 return -ENODEV;
182
183         /* Now, we would do the remaining detection. But the PCF8591 is plainly
184            impossible to detect! Stupid chip. */
185
186         strlcpy(info->type, "pcf8591", I2C_NAME_SIZE);
187
188         return 0;
189 }
190
191 static int pcf8591_probe(struct i2c_client *client,
192                          const struct i2c_device_id *id)
193 {
194         struct pcf8591_data *data;
195         int err;
196
197         if (!(data = kzalloc(sizeof(struct pcf8591_data), GFP_KERNEL))) {
198                 err = -ENOMEM;
199                 goto exit;
200         }
201
202         i2c_set_clientdata(client, data);
203         mutex_init(&data->update_lock);
204
205         /* Initialize the PCF8591 chip */
206         pcf8591_init_client(client);
207
208         /* Register sysfs hooks */
209         err = sysfs_create_group(&client->dev.kobj, &pcf8591_attr_group);
210         if (err)
211                 goto exit_kfree;
212
213         /* Register input2 if not in "two differential inputs" mode */
214         if (input_mode != 3) {
215                 if ((err = device_create_file(&client->dev,
216                                               &dev_attr_in2_input)))
217                         goto exit_sysfs_remove;
218         }
219
220         /* Register input3 only in "four single ended inputs" mode */
221         if (input_mode == 0) {
222                 if ((err = device_create_file(&client->dev,
223                                               &dev_attr_in3_input)))
224                         goto exit_sysfs_remove;
225         }
226
227         data->hwmon_dev = hwmon_device_register(&client->dev);
228         if (IS_ERR(data->hwmon_dev)) {
229                 err = PTR_ERR(data->hwmon_dev);
230                 goto exit_sysfs_remove;
231         }
232
233         return 0;
234
235 exit_sysfs_remove:
236         sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group_opt);
237         sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group);
238 exit_kfree:
239         kfree(data);
240 exit:
241         return err;
242 }
243
244 static int pcf8591_remove(struct i2c_client *client)
245 {
246         struct pcf8591_data *data = i2c_get_clientdata(client);
247
248         hwmon_device_unregister(data->hwmon_dev);
249         sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group_opt);
250         sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group);
251         kfree(i2c_get_clientdata(client));
252         return 0;
253 }
254
255 /* Called when we have found a new PCF8591. */
256 static void pcf8591_init_client(struct i2c_client *client)
257 {
258         struct pcf8591_data *data = i2c_get_clientdata(client);
259         data->control = PCF8591_INIT_CONTROL;
260         data->aout = PCF8591_INIT_AOUT;
261
262         i2c_smbus_write_byte_data(client, data->control, data->aout);
263
264         /* The first byte transmitted contains the conversion code of the
265            previous read cycle. FLUSH IT! */
266         i2c_smbus_read_byte(client);
267 }
268
269 static int pcf8591_read_channel(struct device *dev, int channel)
270 {
271         u8 value;
272         struct i2c_client *client = to_i2c_client(dev);
273         struct pcf8591_data *data = i2c_get_clientdata(client);
274
275         mutex_lock(&data->update_lock);
276
277         if ((data->control & PCF8591_CONTROL_AICH_MASK) != channel) {
278                 data->control = (data->control & ~PCF8591_CONTROL_AICH_MASK)
279                               | channel;
280                 i2c_smbus_write_byte(client, data->control);
281
282                 /* The first byte transmitted contains the conversion code of
283                    the previous read cycle. FLUSH IT! */
284                 i2c_smbus_read_byte(client);
285         }
286         value = i2c_smbus_read_byte(client);
287
288         mutex_unlock(&data->update_lock);
289
290         if ((channel == 2 && input_mode == 2) ||
291             (channel != 3 && (input_mode == 1 || input_mode == 3)))
292                 return (10 * REG_TO_SIGNED(value));
293         else
294                 return (10 * value);
295 }
296
297 static const struct i2c_device_id pcf8591_id[] = {
298         { "pcf8591", 0 },
299         { }
300 };
301 MODULE_DEVICE_TABLE(i2c, pcf8591_id);
302
303 static struct i2c_driver pcf8591_driver = {
304         .driver = {
305                 .name   = "pcf8591",
306         },
307         .probe          = pcf8591_probe,
308         .remove         = pcf8591_remove,
309         .id_table       = pcf8591_id,
310
311         .class          = I2C_CLASS_HWMON,      /* Nearest choice */
312         .detect         = pcf8591_detect,
313         .address_list   = normal_i2c,
314 };
315
316 static int __init pcf8591_init(void)
317 {
318         if (input_mode < 0 || input_mode > 3) {
319                 printk(KERN_WARNING "pcf8591: invalid input_mode (%d)\n",
320                        input_mode);
321                 input_mode = 0;
322         }
323         return i2c_add_driver(&pcf8591_driver);
324 }
325
326 static void __exit pcf8591_exit(void)
327 {
328         i2c_del_driver(&pcf8591_driver);
329 }
330
331 MODULE_AUTHOR("Aurelien Jarno <aurelien@aurel32.net>");
332 MODULE_DESCRIPTION("PCF8591 driver");
333 MODULE_LICENSE("GPL");
334
335 module_init(pcf8591_init);
336 module_exit(pcf8591_exit);