blob: 731b09af76b960b676e55b983dc8ff350b5d0380 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 Copyright (C) 2001-2004 Aurelien Jarno <aurelien@aurel32.net>
Jean Delvarefb4504f2009-03-30 21:46:43 +02003 Ported to Linux 2.6 by Aurelien Jarno <aurelien@aurel32.net> with
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 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
Joe Perches2caec132010-10-20 06:51:45 +000021#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/module.h>
24#include <linux/init.h>
25#include <linux/slab.h>
26#include <linux/i2c.h>
Ingo Molnar5c085d32006-01-18 23:16:04 +010027#include <linux/mutex.h>
Jean Delvare4275fcd2010-10-28 20:31:49 +020028#include <linux/err.h>
29#include <linux/hwmon.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/* Insmod parameters */
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33static int input_mode;
34module_param(input_mode, int, 0);
35MODULE_PARM_DESC(input_mode,
36 "Analog input mode:\n"
37 " 0 = four single ended inputs\n"
38 " 1 = three differential inputs\n"
39 " 2 = single ended and differential mixed\n"
40 " 3 = two differential inputs\n");
41
42/* The PCF8591 control byte
Jean Delvarefb4504f2009-03-30 21:46:43 +020043 7 6 5 4 3 2 1 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 | 0 |AOEF| AIP | 0 |AINC| AICH | */
45
46/* Analog Output Enable Flag (analog output active if 1) */
47#define PCF8591_CONTROL_AOEF 0x40
Jean Delvarefb4504f2009-03-30 21:46:43 +020048
49/* Analog Input Programming
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 0x00 = four single ended inputs
51 0x10 = three differential inputs
52 0x20 = single ended and differential mixed
53 0x30 = two differential inputs */
54#define PCF8591_CONTROL_AIP_MASK 0x30
55
56/* Autoincrement Flag (switch on if 1) */
57#define PCF8591_CONTROL_AINC 0x04
58
59/* Channel selection
Jean Delvarefb4504f2009-03-30 21:46:43 +020060 0x00 = channel 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 0x01 = channel 1
62 0x02 = channel 2
63 0x03 = channel 3 */
64#define PCF8591_CONTROL_AICH_MASK 0x03
65
66/* Initial values */
67#define PCF8591_INIT_CONTROL ((input_mode << 4) | PCF8591_CONTROL_AOEF)
68#define PCF8591_INIT_AOUT 0 /* DAC out = 0 */
69
70/* Conversions */
71#define REG_TO_SIGNED(reg) (((reg) & 0x80)?((reg) - 256):(reg))
72
73struct pcf8591_data {
Jean Delvare4275fcd2010-10-28 20:31:49 +020074 struct device *hwmon_dev;
Ingo Molnar5c085d32006-01-18 23:16:04 +010075 struct mutex update_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 u8 control;
78 u8 aout;
79};
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081static void pcf8591_init_client(struct i2c_client *client);
82static int pcf8591_read_channel(struct device *dev, int channel);
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/* following are the sysfs callback functions */
85#define show_in_channel(channel) \
Yani Ioannoua5099cf2005-05-17 06:42:25 -040086static ssize_t show_in##channel##_input(struct device *dev, struct device_attribute *attr, char *buf) \
Linus Torvalds1da177e2005-04-16 15:20:36 -070087{ \
88 return sprintf(buf, "%d\n", pcf8591_read_channel(dev, channel));\
89} \
90static DEVICE_ATTR(in##channel##_input, S_IRUGO, \
91 show_in##channel##_input, NULL);
92
93show_in_channel(0);
94show_in_channel(1);
95show_in_channel(2);
96show_in_channel(3);
97
Yani Ioannoua5099cf2005-05-17 06:42:25 -040098static ssize_t show_out0_ouput(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099{
100 struct pcf8591_data *data = i2c_get_clientdata(to_i2c_client(dev));
101 return sprintf(buf, "%d\n", data->aout * 10);
102}
103
Yani Ioannoua5099cf2005-05-17 06:42:25 -0400104static ssize_t set_out0_output(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 unsigned int value;
107 struct i2c_client *client = to_i2c_client(dev);
108 struct pcf8591_data *data = i2c_get_clientdata(client);
109 if ((value = (simple_strtoul(buf, NULL, 10) + 5) / 10) <= 255) {
110 data->aout = value;
111 i2c_smbus_write_byte_data(client, data->control, data->aout);
112 return count;
113 }
114 return -EINVAL;
115}
116
Jean Delvarefb4504f2009-03-30 21:46:43 +0200117static DEVICE_ATTR(out0_output, S_IWUSR | S_IRUGO,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 show_out0_ouput, set_out0_output);
119
Yani Ioannoua5099cf2005-05-17 06:42:25 -0400120static ssize_t show_out0_enable(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
122 struct pcf8591_data *data = i2c_get_clientdata(to_i2c_client(dev));
123 return sprintf(buf, "%u\n", !(!(data->control & PCF8591_CONTROL_AOEF)));
124}
125
Yani Ioannoua5099cf2005-05-17 06:42:25 -0400126static ssize_t set_out0_enable(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
128 struct i2c_client *client = to_i2c_client(dev);
129 struct pcf8591_data *data = i2c_get_clientdata(client);
130 unsigned long val = simple_strtoul(buf, NULL, 10);
131
Ingo Molnar5c085d32006-01-18 23:16:04 +0100132 mutex_lock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 if (val)
134 data->control |= PCF8591_CONTROL_AOEF;
135 else
136 data->control &= ~PCF8591_CONTROL_AOEF;
137 i2c_smbus_write_byte(client, data->control);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100138 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 return count;
140}
141
Jean Delvarefb4504f2009-03-30 21:46:43 +0200142static DEVICE_ATTR(out0_enable, S_IWUSR | S_IRUGO,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 show_out0_enable, set_out0_enable);
144
Jean Delvare7d9db672006-09-03 22:20:24 +0200145static struct attribute *pcf8591_attributes[] = {
146 &dev_attr_out0_enable.attr,
147 &dev_attr_out0_output.attr,
148 &dev_attr_in0_input.attr,
149 &dev_attr_in1_input.attr,
150 NULL
151};
152
153static const struct attribute_group pcf8591_attr_group = {
154 .attrs = pcf8591_attributes,
155};
156
157static struct attribute *pcf8591_attributes_opt[] = {
158 &dev_attr_in2_input.attr,
159 &dev_attr_in3_input.attr,
160 NULL
161};
162
163static const struct attribute_group pcf8591_attr_group_opt = {
164 .attrs = pcf8591_attributes_opt,
165};
166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167/*
168 * Real code
169 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Jean Delvare8b77e6a2008-07-16 19:30:06 +0200171static int pcf8591_probe(struct i2c_client *client,
172 const struct i2c_device_id *id)
173{
174 struct pcf8591_data *data;
175 int err;
176
Deepak Saxena5263ebb2005-10-17 23:09:43 +0200177 if (!(data = kzalloc(sizeof(struct pcf8591_data), GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 err = -ENOMEM;
179 goto exit;
180 }
Jean Delvarefb4504f2009-03-30 21:46:43 +0200181
Jean Delvaref741f672008-07-14 22:38:36 +0200182 i2c_set_clientdata(client, data);
Ingo Molnar5c085d32006-01-18 23:16:04 +0100183 mutex_init(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 /* Initialize the PCF8591 chip */
Jean Delvaref741f672008-07-14 22:38:36 +0200186 pcf8591_init_client(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188 /* Register sysfs hooks */
Jean Delvaref741f672008-07-14 22:38:36 +0200189 err = sysfs_create_group(&client->dev.kobj, &pcf8591_attr_group);
Jean Delvare7d9db672006-09-03 22:20:24 +0200190 if (err)
Jean Delvare8b77e6a2008-07-16 19:30:06 +0200191 goto exit_kfree;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193 /* Register input2 if not in "two differential inputs" mode */
Jean Delvare7d9db672006-09-03 22:20:24 +0200194 if (input_mode != 3) {
Jean Delvaref741f672008-07-14 22:38:36 +0200195 if ((err = device_create_file(&client->dev,
Jean Delvare7d9db672006-09-03 22:20:24 +0200196 &dev_attr_in2_input)))
197 goto exit_sysfs_remove;
198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Jean Delvare7d9db672006-09-03 22:20:24 +0200200 /* Register input3 only in "four single ended inputs" mode */
201 if (input_mode == 0) {
Jean Delvaref741f672008-07-14 22:38:36 +0200202 if ((err = device_create_file(&client->dev,
Jean Delvare7d9db672006-09-03 22:20:24 +0200203 &dev_attr_in3_input)))
204 goto exit_sysfs_remove;
205 }
206
Jean Delvare4275fcd2010-10-28 20:31:49 +0200207 data->hwmon_dev = hwmon_device_register(&client->dev);
208 if (IS_ERR(data->hwmon_dev)) {
209 err = PTR_ERR(data->hwmon_dev);
210 goto exit_sysfs_remove;
211 }
212
Jean Delvare7d9db672006-09-03 22:20:24 +0200213 return 0;
214
215exit_sysfs_remove:
Jean Delvaref741f672008-07-14 22:38:36 +0200216 sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group_opt);
217 sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218exit_kfree:
219 kfree(data);
220exit:
221 return err;
222}
223
Jean Delvare8b77e6a2008-07-16 19:30:06 +0200224static int pcf8591_remove(struct i2c_client *client)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
Jean Delvare4275fcd2010-10-28 20:31:49 +0200226 struct pcf8591_data *data = i2c_get_clientdata(client);
227
228 hwmon_device_unregister(data->hwmon_dev);
Jean Delvare7d9db672006-09-03 22:20:24 +0200229 sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group_opt);
230 sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 kfree(i2c_get_clientdata(client));
232 return 0;
233}
234
235/* Called when we have found a new PCF8591. */
236static void pcf8591_init_client(struct i2c_client *client)
237{
238 struct pcf8591_data *data = i2c_get_clientdata(client);
239 data->control = PCF8591_INIT_CONTROL;
240 data->aout = PCF8591_INIT_AOUT;
241
242 i2c_smbus_write_byte_data(client, data->control, data->aout);
Jean Delvarefb4504f2009-03-30 21:46:43 +0200243
244 /* The first byte transmitted contains the conversion code of the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 previous read cycle. FLUSH IT! */
246 i2c_smbus_read_byte(client);
247}
248
249static int pcf8591_read_channel(struct device *dev, int channel)
250{
251 u8 value;
252 struct i2c_client *client = to_i2c_client(dev);
253 struct pcf8591_data *data = i2c_get_clientdata(client);
254
Ingo Molnar5c085d32006-01-18 23:16:04 +0100255 mutex_lock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257 if ((data->control & PCF8591_CONTROL_AICH_MASK) != channel) {
258 data->control = (data->control & ~PCF8591_CONTROL_AICH_MASK)
259 | channel;
260 i2c_smbus_write_byte(client, data->control);
Jean Delvarefb4504f2009-03-30 21:46:43 +0200261
262 /* The first byte transmitted contains the conversion code of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 the previous read cycle. FLUSH IT! */
264 i2c_smbus_read_byte(client);
265 }
266 value = i2c_smbus_read_byte(client);
267
Ingo Molnar5c085d32006-01-18 23:16:04 +0100268 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
270 if ((channel == 2 && input_mode == 2) ||
271 (channel != 3 && (input_mode == 1 || input_mode == 3)))
272 return (10 * REG_TO_SIGNED(value));
273 else
274 return (10 * value);
275}
276
Jean Delvare8b77e6a2008-07-16 19:30:06 +0200277static const struct i2c_device_id pcf8591_id[] = {
278 { "pcf8591", 0 },
279 { }
280};
281MODULE_DEVICE_TABLE(i2c, pcf8591_id);
282
283static struct i2c_driver pcf8591_driver = {
284 .driver = {
285 .name = "pcf8591",
286 },
287 .probe = pcf8591_probe,
288 .remove = pcf8591_remove,
289 .id_table = pcf8591_id,
Jean Delvare8b77e6a2008-07-16 19:30:06 +0200290};
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292static int __init pcf8591_init(void)
293{
294 if (input_mode < 0 || input_mode > 3) {
Joe Perches2caec132010-10-20 06:51:45 +0000295 pr_warn("invalid input_mode (%d)\n", input_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 input_mode = 0;
297 }
298 return i2c_add_driver(&pcf8591_driver);
299}
300
301static void __exit pcf8591_exit(void)
302{
303 i2c_del_driver(&pcf8591_driver);
304}
305
306MODULE_AUTHOR("Aurelien Jarno <aurelien@aurel32.net>");
307MODULE_DESCRIPTION("PCF8591 driver");
308MODULE_LICENSE("GPL");
309
310module_init(pcf8591_init);
311module_exit(pcf8591_exit);