4 * The adcxx4s is an AD converter family from National Semiconductor (NS).
6 * Copyright (c) 2008 Marc Pignat <marc.pignat@hevs.ch>
8 * The adcxx4s communicates with a host processor via an SPI/Microwire Bus
9 * interface. This driver supports the whole family of devices with name
10 * ADC<bb><c>S<sss>, where
11 * * bb is the resolution in number of bits (8, 10, 12)
12 * * c is the number of channels (1, 2, 4, 8)
13 * * sss is the maximum conversion speed (021 for 200 kSPS, 051 for 500 kSPS
16 * Complete datasheets are available at National's website here:
17 * http://www.national.com/ds/DC/ADC<bb><c>S<sss>.pdf
19 * Handling of 8, 10 and 12 bits converters are the same, the
20 * unavailable bits are 0 :)
22 * This program is free software; you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation; either version 2 of the License, or
25 * (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program; if not, write to the Free Software
34 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
37 #include <linux/init.h>
38 #include <linux/module.h>
39 #include <linux/kernel.h>
40 #include <linux/device.h>
41 #include <linux/err.h>
42 #include <linux/sysfs.h>
43 #include <linux/hwmon.h>
44 #include <linux/hwmon-sysfs.h>
45 #include <linux/mutex.h>
46 #include <linux/spi/spi.h>
48 #define DRVNAME "adcxx"
51 struct device *hwmon_dev;
54 u32 reference; /* in millivolts */
57 /* sysfs hook function */
58 static ssize_t adcxx_read(struct device *dev,
59 struct device_attribute *devattr, char *buf)
61 struct spi_device *spi = to_spi_device(dev);
62 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
63 struct adcxx *adc = dev_get_drvdata(&spi->dev);
64 u8 tx_buf[2] = { attr->index << 3 }; /* other bits are don't care */
69 if (mutex_lock_interruptible(&adc->lock))
72 status = spi_write_then_read(spi, tx_buf, sizeof(tx_buf),
73 rx_buf, sizeof(rx_buf));
75 dev_warn(dev, "spi_write_then_read failed with status %d\n",
80 value = (rx_buf[0] << 8) + rx_buf[1];
81 dev_dbg(dev, "raw value = 0x%x\n", value);
83 value = value * adc->reference >> 12;
84 status = sprintf(buf, "%d\n", value);
86 mutex_unlock(&adc->lock);
90 static ssize_t adcxx_show_min(struct device *dev,
91 struct device_attribute *devattr, char *buf)
93 /* The minimum reference is 0 for this chip family */
94 return sprintf(buf, "0\n");
97 static ssize_t adcxx_show_max(struct device *dev,
98 struct device_attribute *devattr, char *buf)
100 struct spi_device *spi = to_spi_device(dev);
101 struct adcxx *adc = dev_get_drvdata(&spi->dev);
104 if (mutex_lock_interruptible(&adc->lock))
107 reference = adc->reference;
109 mutex_unlock(&adc->lock);
111 return sprintf(buf, "%d\n", reference);
114 static ssize_t adcxx_set_max(struct device *dev,
115 struct device_attribute *devattr, const char *buf, size_t count)
117 struct spi_device *spi = to_spi_device(dev);
118 struct adcxx *adc = dev_get_drvdata(&spi->dev);
121 if (strict_strtoul(buf, 10, &value))
124 if (mutex_lock_interruptible(&adc->lock))
127 adc->reference = value;
129 mutex_unlock(&adc->lock);
134 static ssize_t adcxx_show_name(struct device *dev, struct device_attribute
137 struct spi_device *spi = to_spi_device(dev);
138 struct adcxx *adc = dev_get_drvdata(&spi->dev);
140 return sprintf(buf, "adcxx%ds\n", adc->channels);
143 static struct sensor_device_attribute ad_input[] = {
144 SENSOR_ATTR(name, S_IRUGO, adcxx_show_name, NULL, 0),
145 SENSOR_ATTR(in_min, S_IRUGO, adcxx_show_min, NULL, 0),
146 SENSOR_ATTR(in_max, S_IWUSR | S_IRUGO, adcxx_show_max,
148 SENSOR_ATTR(in0_input, S_IRUGO, adcxx_read, NULL, 0),
149 SENSOR_ATTR(in1_input, S_IRUGO, adcxx_read, NULL, 1),
150 SENSOR_ATTR(in2_input, S_IRUGO, adcxx_read, NULL, 2),
151 SENSOR_ATTR(in3_input, S_IRUGO, adcxx_read, NULL, 3),
152 SENSOR_ATTR(in4_input, S_IRUGO, adcxx_read, NULL, 4),
153 SENSOR_ATTR(in5_input, S_IRUGO, adcxx_read, NULL, 5),
154 SENSOR_ATTR(in6_input, S_IRUGO, adcxx_read, NULL, 6),
155 SENSOR_ATTR(in7_input, S_IRUGO, adcxx_read, NULL, 7),
158 /*----------------------------------------------------------------------*/
160 static int __devinit adcxx_probe(struct spi_device *spi, int channels)
166 adc = kzalloc(sizeof *adc, GFP_KERNEL);
170 /* set a default value for the reference */
171 adc->reference = 3300;
172 adc->channels = channels;
173 mutex_init(&adc->lock);
175 mutex_lock(&adc->lock);
177 dev_set_drvdata(&spi->dev, adc);
179 for (i = 0; i < 3 + adc->channels; i++) {
180 status = device_create_file(&spi->dev, &ad_input[i].dev_attr);
182 dev_err(&spi->dev, "device_create_file failed.\n");
187 adc->hwmon_dev = hwmon_device_register(&spi->dev);
188 if (IS_ERR(adc->hwmon_dev)) {
189 dev_err(&spi->dev, "hwmon_device_register failed.\n");
190 status = PTR_ERR(adc->hwmon_dev);
194 mutex_unlock(&adc->lock);
198 for (i--; i >= 0; i--)
199 device_remove_file(&spi->dev, &ad_input[i].dev_attr);
201 dev_set_drvdata(&spi->dev, NULL);
202 mutex_unlock(&adc->lock);
207 static int __devinit adcxx1s_probe(struct spi_device *spi)
209 return adcxx_probe(spi, 1);
212 static int __devinit adcxx2s_probe(struct spi_device *spi)
214 return adcxx_probe(spi, 2);
217 static int __devinit adcxx4s_probe(struct spi_device *spi)
219 return adcxx_probe(spi, 4);
222 static int __devinit adcxx8s_probe(struct spi_device *spi)
224 return adcxx_probe(spi, 8);
227 static int __devexit adcxx_remove(struct spi_device *spi)
229 struct adcxx *adc = dev_get_drvdata(&spi->dev);
232 mutex_lock(&adc->lock);
233 hwmon_device_unregister(adc->hwmon_dev);
234 for (i = 0; i < 3 + adc->channels; i++)
235 device_remove_file(&spi->dev, &ad_input[i].dev_attr);
237 dev_set_drvdata(&spi->dev, NULL);
238 mutex_unlock(&adc->lock);
244 static struct spi_driver adcxx1s_driver = {
247 .owner = THIS_MODULE,
249 .probe = adcxx1s_probe,
250 .remove = __devexit_p(adcxx_remove),
253 static struct spi_driver adcxx2s_driver = {
256 .owner = THIS_MODULE,
258 .probe = adcxx2s_probe,
259 .remove = __devexit_p(adcxx_remove),
262 static struct spi_driver adcxx4s_driver = {
265 .owner = THIS_MODULE,
267 .probe = adcxx4s_probe,
268 .remove = __devexit_p(adcxx_remove),
271 static struct spi_driver adcxx8s_driver = {
274 .owner = THIS_MODULE,
276 .probe = adcxx8s_probe,
277 .remove = __devexit_p(adcxx_remove),
280 static int __init init_adcxx(void)
283 status = spi_register_driver(&adcxx1s_driver);
287 status = spi_register_driver(&adcxx2s_driver);
291 status = spi_register_driver(&adcxx4s_driver);
295 status = spi_register_driver(&adcxx8s_driver);
302 spi_unregister_driver(&adcxx4s_driver);
304 spi_unregister_driver(&adcxx2s_driver);
306 spi_unregister_driver(&adcxx1s_driver);
311 static void __exit exit_adcxx(void)
313 spi_unregister_driver(&adcxx1s_driver);
314 spi_unregister_driver(&adcxx2s_driver);
315 spi_unregister_driver(&adcxx4s_driver);
316 spi_unregister_driver(&adcxx8s_driver);
319 module_init(init_adcxx);
320 module_exit(exit_adcxx);
322 MODULE_AUTHOR("Marc Pignat");
323 MODULE_DESCRIPTION("National Semiconductor adcxx8sxxx Linux driver");
324 MODULE_LICENSE("GPL");
326 MODULE_ALIAS("adcxx1s");
327 MODULE_ALIAS("adcxx2s");
328 MODULE_ALIAS("adcxx4s");
329 MODULE_ALIAS("adcxx8s");