Commit | Line | Data |
---|---|---|
74ba9207 | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
1da177e4 | 2 | /* |
57256088 GR |
3 | * Copyright (C) 2001-2004 Aurelien Jarno <aurelien@aurel32.net> |
4 | * Ported to Linux 2.6 by Aurelien Jarno <aurelien@aurel32.net> with | |
7c81c60f | 5 | * the help of Jean Delvare <jdelvare@suse.de> |
57256088 | 6 | */ |
1da177e4 | 7 | |
2caec134 JP |
8 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
9 | ||
1da177e4 LT |
10 | #include <linux/module.h> |
11 | #include <linux/init.h> | |
12 | #include <linux/slab.h> | |
13 | #include <linux/i2c.h> | |
5c085d36 | 14 | #include <linux/mutex.h> |
4275fcd6 JD |
15 | #include <linux/err.h> |
16 | #include <linux/hwmon.h> | |
25f98688 | 17 | #include <linux/kstrtox.h> |
1da177e4 | 18 | |
1da177e4 | 19 | /* Insmod parameters */ |
1da177e4 LT |
20 | |
21 | static int input_mode; | |
22 | module_param(input_mode, int, 0); | |
23 | MODULE_PARM_DESC(input_mode, | |
24 | "Analog input mode:\n" | |
25 | " 0 = four single ended inputs\n" | |
26 | " 1 = three differential inputs\n" | |
27 | " 2 = single ended and differential mixed\n" | |
28 | " 3 = two differential inputs\n"); | |
29 | ||
57256088 GR |
30 | /* |
31 | * The PCF8591 control byte | |
32 | * 7 6 5 4 3 2 1 0 | |
33 | * | 0 |AOEF| AIP | 0 |AINC| AICH | | |
34 | */ | |
1da177e4 LT |
35 | |
36 | /* Analog Output Enable Flag (analog output active if 1) */ | |
37 | #define PCF8591_CONTROL_AOEF 0x40 | |
fb4504fe | 38 | |
57256088 GR |
39 | /* |
40 | * Analog Input Programming | |
41 | * 0x00 = four single ended inputs | |
42 | * 0x10 = three differential inputs | |
43 | * 0x20 = single ended and differential mixed | |
44 | * 0x30 = two differential inputs | |
45 | */ | |
1da177e4 LT |
46 | #define PCF8591_CONTROL_AIP_MASK 0x30 |
47 | ||
48 | /* Autoincrement Flag (switch on if 1) */ | |
49 | #define PCF8591_CONTROL_AINC 0x04 | |
50 | ||
57256088 GR |
51 | /* |
52 | * Channel selection | |
53 | * 0x00 = channel 0 | |
54 | * 0x01 = channel 1 | |
55 | * 0x02 = channel 2 | |
56 | * 0x03 = channel 3 | |
57 | */ | |
1da177e4 LT |
58 | #define PCF8591_CONTROL_AICH_MASK 0x03 |
59 | ||
60 | /* Initial values */ | |
61 | #define PCF8591_INIT_CONTROL ((input_mode << 4) | PCF8591_CONTROL_AOEF) | |
62 | #define PCF8591_INIT_AOUT 0 /* DAC out = 0 */ | |
63 | ||
64 | /* Conversions */ | |
57256088 | 65 | #define REG_TO_SIGNED(reg) (((reg) & 0x80) ? ((reg) - 256) : (reg)) |
1da177e4 LT |
66 | |
67 | struct pcf8591_data { | |
4275fcd6 | 68 | struct device *hwmon_dev; |
5c085d36 | 69 | struct mutex update_lock; |
1da177e4 LT |
70 | |
71 | u8 control; | |
72 | u8 aout; | |
73 | }; | |
74 | ||
1da177e4 LT |
75 | static void pcf8591_init_client(struct i2c_client *client); |
76 | static int pcf8591_read_channel(struct device *dev, int channel); | |
77 | ||
1da177e4 LT |
78 | /* following are the sysfs callback functions */ |
79 | #define show_in_channel(channel) \ | |
57256088 GR |
80 | static ssize_t show_in##channel##_input(struct device *dev, \ |
81 | struct device_attribute *attr, \ | |
82 | char *buf) \ | |
1da177e4 LT |
83 | { \ |
84 | return sprintf(buf, "%d\n", pcf8591_read_channel(dev, channel));\ | |
85 | } \ | |
86 | static DEVICE_ATTR(in##channel##_input, S_IRUGO, \ | |
87 | show_in##channel##_input, NULL); | |
88 | ||
89 | show_in_channel(0); | |
90 | show_in_channel(1); | |
91 | show_in_channel(2); | |
92 | show_in_channel(3); | |
93 | ||
309c675e JL |
94 | static ssize_t out0_output_show(struct device *dev, |
95 | struct device_attribute *attr, char *buf) | |
1da177e4 LT |
96 | { |
97 | struct pcf8591_data *data = i2c_get_clientdata(to_i2c_client(dev)); | |
98 | return sprintf(buf, "%d\n", data->aout * 10); | |
99 | } | |
100 | ||
309c675e JL |
101 | static ssize_t out0_output_store(struct device *dev, |
102 | struct device_attribute *attr, | |
103 | const char *buf, size_t count) | |
1da177e4 | 104 | { |
57256088 | 105 | unsigned long val; |
1da177e4 LT |
106 | struct i2c_client *client = to_i2c_client(dev); |
107 | struct pcf8591_data *data = i2c_get_clientdata(client); | |
57256088 GR |
108 | int err; |
109 | ||
110 | err = kstrtoul(buf, 10, &val); | |
111 | if (err) | |
112 | return err; | |
113 | ||
114 | val /= 10; | |
115 | if (val > 255) | |
116 | return -EINVAL; | |
117 | ||
118 | data->aout = val; | |
119 | i2c_smbus_write_byte_data(client, data->control, data->aout); | |
120 | return count; | |
1da177e4 LT |
121 | } |
122 | ||
309c675e | 123 | static DEVICE_ATTR_RW(out0_output); |
1da177e4 | 124 | |
309c675e | 125 | static ssize_t out0_enable_show(struct device *dev, |
57256088 | 126 | struct device_attribute *attr, char *buf) |
1da177e4 LT |
127 | { |
128 | struct pcf8591_data *data = i2c_get_clientdata(to_i2c_client(dev)); | |
129 | return sprintf(buf, "%u\n", !(!(data->control & PCF8591_CONTROL_AOEF))); | |
130 | } | |
131 | ||
309c675e JL |
132 | static ssize_t out0_enable_store(struct device *dev, |
133 | struct device_attribute *attr, | |
134 | const char *buf, size_t count) | |
1da177e4 LT |
135 | { |
136 | struct i2c_client *client = to_i2c_client(dev); | |
137 | struct pcf8591_data *data = i2c_get_clientdata(client); | |
57256088 GR |
138 | unsigned long val; |
139 | int err; | |
140 | ||
141 | err = kstrtoul(buf, 10, &val); | |
142 | if (err) | |
143 | return err; | |
1da177e4 | 144 | |
5c085d36 | 145 | mutex_lock(&data->update_lock); |
1da177e4 LT |
146 | if (val) |
147 | data->control |= PCF8591_CONTROL_AOEF; | |
148 | else | |
149 | data->control &= ~PCF8591_CONTROL_AOEF; | |
150 | i2c_smbus_write_byte(client, data->control); | |
5c085d36 | 151 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
152 | return count; |
153 | } | |
154 | ||
309c675e | 155 | static DEVICE_ATTR_RW(out0_enable); |
1da177e4 | 156 | |
7d9db67f JD |
157 | static struct attribute *pcf8591_attributes[] = { |
158 | &dev_attr_out0_enable.attr, | |
159 | &dev_attr_out0_output.attr, | |
160 | &dev_attr_in0_input.attr, | |
161 | &dev_attr_in1_input.attr, | |
162 | NULL | |
163 | }; | |
164 | ||
165 | static const struct attribute_group pcf8591_attr_group = { | |
166 | .attrs = pcf8591_attributes, | |
167 | }; | |
168 | ||
169 | static struct attribute *pcf8591_attributes_opt[] = { | |
170 | &dev_attr_in2_input.attr, | |
171 | &dev_attr_in3_input.attr, | |
172 | NULL | |
173 | }; | |
174 | ||
175 | static const struct attribute_group pcf8591_attr_group_opt = { | |
176 | .attrs = pcf8591_attributes_opt, | |
177 | }; | |
178 | ||
1da177e4 LT |
179 | /* |
180 | * Real code | |
181 | */ | |
1da177e4 | 182 | |
67487038 | 183 | static int pcf8591_probe(struct i2c_client *client) |
8b77e6ac JD |
184 | { |
185 | struct pcf8591_data *data; | |
186 | int err; | |
1da177e4 | 187 | |
60c2b569 GR |
188 | data = devm_kzalloc(&client->dev, sizeof(struct pcf8591_data), |
189 | GFP_KERNEL); | |
190 | if (!data) | |
191 | return -ENOMEM; | |
fb4504fe | 192 | |
f741f673 | 193 | i2c_set_clientdata(client, data); |
5c085d36 | 194 | mutex_init(&data->update_lock); |
1da177e4 | 195 | |
1da177e4 | 196 | /* Initialize the PCF8591 chip */ |
f741f673 | 197 | pcf8591_init_client(client); |
1da177e4 LT |
198 | |
199 | /* Register sysfs hooks */ | |
f741f673 | 200 | err = sysfs_create_group(&client->dev.kobj, &pcf8591_attr_group); |
7d9db67f | 201 | if (err) |
60c2b569 | 202 | return err; |
1da177e4 LT |
203 | |
204 | /* Register input2 if not in "two differential inputs" mode */ | |
7d9db67f | 205 | if (input_mode != 3) { |
57256088 GR |
206 | err = device_create_file(&client->dev, &dev_attr_in2_input); |
207 | if (err) | |
7d9db67f JD |
208 | goto exit_sysfs_remove; |
209 | } | |
210 | ||
1da177e4 | 211 | /* Register input3 only in "four single ended inputs" mode */ |
7d9db67f | 212 | if (input_mode == 0) { |
57256088 GR |
213 | err = device_create_file(&client->dev, &dev_attr_in3_input); |
214 | if (err) | |
7d9db67f JD |
215 | goto exit_sysfs_remove; |
216 | } | |
217 | ||
4275fcd6 JD |
218 | data->hwmon_dev = hwmon_device_register(&client->dev); |
219 | if (IS_ERR(data->hwmon_dev)) { | |
220 | err = PTR_ERR(data->hwmon_dev); | |
221 | goto exit_sysfs_remove; | |
222 | } | |
223 | ||
1da177e4 | 224 | return 0; |
1da177e4 | 225 | |
7d9db67f | 226 | exit_sysfs_remove: |
f741f673 JD |
227 | sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group_opt); |
228 | sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group); | |
1da177e4 LT |
229 | return err; |
230 | } | |
231 | ||
ed5c2f5f | 232 | static void pcf8591_remove(struct i2c_client *client) |
1da177e4 | 233 | { |
4275fcd6 JD |
234 | struct pcf8591_data *data = i2c_get_clientdata(client); |
235 | ||
236 | hwmon_device_unregister(data->hwmon_dev); | |
7d9db67f JD |
237 | sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group_opt); |
238 | sysfs_remove_group(&client->dev.kobj, &pcf8591_attr_group); | |
1da177e4 LT |
239 | } |
240 | ||
241 | /* Called when we have found a new PCF8591. */ | |
242 | static void pcf8591_init_client(struct i2c_client *client) | |
243 | { | |
244 | struct pcf8591_data *data = i2c_get_clientdata(client); | |
245 | data->control = PCF8591_INIT_CONTROL; | |
246 | data->aout = PCF8591_INIT_AOUT; | |
247 | ||
248 | i2c_smbus_write_byte_data(client, data->control, data->aout); | |
fb4504fe | 249 | |
57256088 GR |
250 | /* |
251 | * The first byte transmitted contains the conversion code of the | |
252 | * previous read cycle. FLUSH IT! | |
253 | */ | |
1da177e4 LT |
254 | i2c_smbus_read_byte(client); |
255 | } | |
256 | ||
257 | static int pcf8591_read_channel(struct device *dev, int channel) | |
258 | { | |
259 | u8 value; | |
260 | struct i2c_client *client = to_i2c_client(dev); | |
261 | struct pcf8591_data *data = i2c_get_clientdata(client); | |
262 | ||
5c085d36 | 263 | mutex_lock(&data->update_lock); |
1da177e4 LT |
264 | |
265 | if ((data->control & PCF8591_CONTROL_AICH_MASK) != channel) { | |
266 | data->control = (data->control & ~PCF8591_CONTROL_AICH_MASK) | |
267 | | channel; | |
268 | i2c_smbus_write_byte(client, data->control); | |
fb4504fe | 269 | |
57256088 GR |
270 | /* |
271 | * The first byte transmitted contains the conversion code of | |
272 | * the previous read cycle. FLUSH IT! | |
273 | */ | |
1da177e4 LT |
274 | i2c_smbus_read_byte(client); |
275 | } | |
276 | value = i2c_smbus_read_byte(client); | |
277 | ||
5c085d36 | 278 | mutex_unlock(&data->update_lock); |
1da177e4 LT |
279 | |
280 | if ((channel == 2 && input_mode == 2) || | |
281 | (channel != 3 && (input_mode == 1 || input_mode == 3))) | |
7fe83ad8 | 282 | return 10 * REG_TO_SIGNED(value); |
1da177e4 | 283 | else |
7fe83ad8 | 284 | return 10 * value; |
1da177e4 LT |
285 | } |
286 | ||
8b77e6ac JD |
287 | static const struct i2c_device_id pcf8591_id[] = { |
288 | { "pcf8591", 0 }, | |
289 | { } | |
290 | }; | |
291 | MODULE_DEVICE_TABLE(i2c, pcf8591_id); | |
292 | ||
293 | static struct i2c_driver pcf8591_driver = { | |
294 | .driver = { | |
295 | .name = "pcf8591", | |
296 | }, | |
67487038 | 297 | .probe_new = pcf8591_probe, |
8b77e6ac JD |
298 | .remove = pcf8591_remove, |
299 | .id_table = pcf8591_id, | |
8b77e6ac JD |
300 | }; |
301 | ||
1da177e4 LT |
302 | static int __init pcf8591_init(void) |
303 | { | |
304 | if (input_mode < 0 || input_mode > 3) { | |
2caec134 | 305 | pr_warn("invalid input_mode (%d)\n", input_mode); |
1da177e4 LT |
306 | input_mode = 0; |
307 | } | |
308 | return i2c_add_driver(&pcf8591_driver); | |
309 | } | |
310 | ||
311 | static void __exit pcf8591_exit(void) | |
312 | { | |
313 | i2c_del_driver(&pcf8591_driver); | |
314 | } | |
315 | ||
316 | MODULE_AUTHOR("Aurelien Jarno <aurelien@aurel32.net>"); | |
317 | MODULE_DESCRIPTION("PCF8591 driver"); | |
318 | MODULE_LICENSE("GPL"); | |
319 | ||
320 | module_init(pcf8591_init); | |
321 | module_exit(pcf8591_exit); |