blob: ba962ac4b81f2e63519ee12138e1b2e298befe90 [file] [log] [blame]
Steve Hardy5812f922008-01-22 23:00:02 +00001/*
Guillaume Roguez0962e0f2012-10-03 16:54:08 -04002 * ads7828.c - driver for TI ADS7828 8-channel A/D converter and compatibles
Guenter Roeckd13d6232012-01-19 11:02:14 -08003 * (C) 2007 EADS Astrium
4 *
5 * This driver is based on the lm75 and other lm_sensors/hwmon drivers
6 *
7 * Written by Steve Hardy <shardy@redhat.com>
8 *
Guillaume Roguez0962e0f2012-10-03 16:54:08 -04009 * ADS7830 support, by Guillaume Roguez <guillaume.roguez@savoirfairelinux.com>
10 *
Vivien Didelot46d78462012-10-03 16:54:07 -040011 * For further information, see the Documentation/hwmon/ads7828 file.
Guenter Roeckd13d6232012-01-19 11:02:14 -080012 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 */
Steve Hardy5812f922008-01-22 23:00:02 +000027
Vivien Didelot46d78462012-10-03 16:54:07 -040028#include <linux/err.h>
Steve Hardy5812f922008-01-22 23:00:02 +000029#include <linux/hwmon.h>
30#include <linux/hwmon-sysfs.h>
Vivien Didelot46d78462012-10-03 16:54:07 -040031#include <linux/i2c.h>
32#include <linux/init.h>
33#include <linux/jiffies.h>
34#include <linux/module.h>
Steve Hardy5812f922008-01-22 23:00:02 +000035#include <linux/mutex.h>
Vivien Didelot46d78462012-10-03 16:54:07 -040036#include <linux/platform_data/ads7828.h>
37#include <linux/slab.h>
Steve Hardy5812f922008-01-22 23:00:02 +000038
39/* The ADS7828 registers */
Vivien Didelot46d78462012-10-03 16:54:07 -040040#define ADS7828_NCH 8 /* 8 channels supported */
41#define ADS7828_CMD_SD_SE 0x80 /* Single ended inputs */
42#define ADS7828_CMD_PD1 0x04 /* Internal vref OFF && A/D ON */
43#define ADS7828_CMD_PD3 0x0C /* Internal vref ON && A/D ON */
44#define ADS7828_INT_VREF_MV 2500 /* Internal vref is 2.5V, 2500mV */
45#define ADS7828_EXT_VREF_MV_MIN 50 /* External vref min value 0.05V */
46#define ADS7828_EXT_VREF_MV_MAX 5250 /* External vref max value 5.25V */
Steve Hardy5812f922008-01-22 23:00:02 +000047
Guillaume Roguez0962e0f2012-10-03 16:54:08 -040048/* List of supported devices */
49enum ads7828_chips { ads7828, ads7830 };
50
Vivien Didelot46d78462012-10-03 16:54:07 -040051/* Client specific data */
Steve Hardy5812f922008-01-22 23:00:02 +000052struct ads7828_data {
Steve Hardy5812f922008-01-22 23:00:02 +000053 struct device *hwmon_dev;
Vivien Didelot46d78462012-10-03 16:54:07 -040054 struct mutex update_lock; /* Mutex protecting updates */
55 unsigned long last_updated; /* Last updated time (in jiffies) */
56 u16 adc_input[ADS7828_NCH]; /* ADS7828_NCH samples */
57 bool valid; /* Validity flag */
58 bool diff_input; /* Differential input */
59 bool ext_vref; /* External voltage reference */
60 unsigned int vref_mv; /* voltage reference value */
61 u8 cmd_byte; /* Command byte without channel bits */
62 unsigned int lsb_resol; /* Resolution of the ADC sample LSB */
Guillaume Roguez0962e0f2012-10-03 16:54:08 -040063 s32 (*read_channel)(const struct i2c_client *client, u8 command);
Steve Hardy5812f922008-01-22 23:00:02 +000064};
65
Vivien Didelot46d78462012-10-03 16:54:07 -040066/* Command byte C2,C1,C0 - see datasheet */
67static inline u8 ads7828_cmd_byte(u8 cmd, int ch)
Steve Hardy5812f922008-01-22 23:00:02 +000068{
Vivien Didelot46d78462012-10-03 16:54:07 -040069 return cmd | (((ch >> 1) | (ch & 0x01) << 2) << 4);
Steve Hardy5812f922008-01-22 23:00:02 +000070}
71
72/* Update data for the device (all 8 channels) */
73static struct ads7828_data *ads7828_update_device(struct device *dev)
74{
75 struct i2c_client *client = to_i2c_client(dev);
76 struct ads7828_data *data = i2c_get_clientdata(client);
77
78 mutex_lock(&data->update_lock);
79
80 if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
81 || !data->valid) {
82 unsigned int ch;
83 dev_dbg(&client->dev, "Starting ads7828 update\n");
84
85 for (ch = 0; ch < ADS7828_NCH; ch++) {
Vivien Didelot46d78462012-10-03 16:54:07 -040086 u8 cmd = ads7828_cmd_byte(data->cmd_byte, ch);
Guillaume Roguez0962e0f2012-10-03 16:54:08 -040087 data->adc_input[ch] = data->read_channel(client, cmd);
Steve Hardy5812f922008-01-22 23:00:02 +000088 }
89 data->last_updated = jiffies;
Vivien Didelot46d78462012-10-03 16:54:07 -040090 data->valid = true;
Steve Hardy5812f922008-01-22 23:00:02 +000091 }
92
93 mutex_unlock(&data->update_lock);
94
95 return data;
96}
97
98/* sysfs callback function */
Vivien Didelot46d78462012-10-03 16:54:07 -040099static ssize_t ads7828_show_in(struct device *dev, struct device_attribute *da,
100 char *buf)
Steve Hardy5812f922008-01-22 23:00:02 +0000101{
102 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
103 struct ads7828_data *data = ads7828_update_device(dev);
Vivien Didelot46d78462012-10-03 16:54:07 -0400104 unsigned int value = DIV_ROUND_CLOSEST(data->adc_input[attr->index] *
105 data->lsb_resol, 1000);
106
107 return sprintf(buf, "%d\n", value);
Steve Hardy5812f922008-01-22 23:00:02 +0000108}
109
Vivien Didelot46d78462012-10-03 16:54:07 -0400110static SENSOR_DEVICE_ATTR(in0_input, S_IRUGO, ads7828_show_in, NULL, 0);
111static SENSOR_DEVICE_ATTR(in1_input, S_IRUGO, ads7828_show_in, NULL, 1);
112static SENSOR_DEVICE_ATTR(in2_input, S_IRUGO, ads7828_show_in, NULL, 2);
113static SENSOR_DEVICE_ATTR(in3_input, S_IRUGO, ads7828_show_in, NULL, 3);
114static SENSOR_DEVICE_ATTR(in4_input, S_IRUGO, ads7828_show_in, NULL, 4);
115static SENSOR_DEVICE_ATTR(in5_input, S_IRUGO, ads7828_show_in, NULL, 5);
116static SENSOR_DEVICE_ATTR(in6_input, S_IRUGO, ads7828_show_in, NULL, 6);
117static SENSOR_DEVICE_ATTR(in7_input, S_IRUGO, ads7828_show_in, NULL, 7);
Steve Hardy5812f922008-01-22 23:00:02 +0000118
119static struct attribute *ads7828_attributes[] = {
120 &sensor_dev_attr_in0_input.dev_attr.attr,
121 &sensor_dev_attr_in1_input.dev_attr.attr,
122 &sensor_dev_attr_in2_input.dev_attr.attr,
123 &sensor_dev_attr_in3_input.dev_attr.attr,
124 &sensor_dev_attr_in4_input.dev_attr.attr,
125 &sensor_dev_attr_in5_input.dev_attr.attr,
126 &sensor_dev_attr_in6_input.dev_attr.attr,
127 &sensor_dev_attr_in7_input.dev_attr.attr,
128 NULL
129};
130
131static const struct attribute_group ads7828_group = {
132 .attrs = ads7828_attributes,
133};
134
Jean Delvare7347cb32008-07-16 19:30:10 +0200135static int ads7828_remove(struct i2c_client *client)
Steve Hardy5812f922008-01-22 23:00:02 +0000136{
137 struct ads7828_data *data = i2c_get_clientdata(client);
Vivien Didelot46d78462012-10-03 16:54:07 -0400138
Steve Hardy5812f922008-01-22 23:00:02 +0000139 hwmon_device_unregister(data->hwmon_dev);
140 sysfs_remove_group(&client->dev.kobj, &ads7828_group);
Steve Hardy5812f922008-01-22 23:00:02 +0000141
Jean Delvare7347cb32008-07-16 19:30:10 +0200142 return 0;
143}
Steve Hardy5812f922008-01-22 23:00:02 +0000144
Jean Delvare7347cb32008-07-16 19:30:10 +0200145static int ads7828_probe(struct i2c_client *client,
146 const struct i2c_device_id *id)
147{
Vivien Didelot46d78462012-10-03 16:54:07 -0400148 struct ads7828_platform_data *pdata = client->dev.platform_data;
Jean Delvare7347cb32008-07-16 19:30:10 +0200149 struct ads7828_data *data;
150 int err;
Steve Hardy5812f922008-01-22 23:00:02 +0000151
Guenter Roeck34e3f7f2012-06-02 09:58:00 -0700152 data = devm_kzalloc(&client->dev, sizeof(struct ads7828_data),
153 GFP_KERNEL);
154 if (!data)
155 return -ENOMEM;
Steve Hardy5812f922008-01-22 23:00:02 +0000156
Vivien Didelot46d78462012-10-03 16:54:07 -0400157 if (pdata) {
158 data->diff_input = pdata->diff_input;
159 data->ext_vref = pdata->ext_vref;
160 if (data->ext_vref)
161 data->vref_mv = pdata->vref_mv;
162 }
163
164 /* Bound Vref with min/max values if it was provided */
165 if (data->vref_mv)
Guenter Roeck2a844c12013-01-09 08:09:34 -0800166 data->vref_mv = clamp_val(data->vref_mv,
167 ADS7828_EXT_VREF_MV_MIN,
168 ADS7828_EXT_VREF_MV_MAX);
Vivien Didelot46d78462012-10-03 16:54:07 -0400169 else
170 data->vref_mv = ADS7828_INT_VREF_MV;
171
Guillaume Roguez0962e0f2012-10-03 16:54:08 -0400172 /* ADS7828 uses 12-bit samples, while ADS7830 is 8-bit */
173 if (id->driver_data == ads7828) {
174 data->lsb_resol = DIV_ROUND_CLOSEST(data->vref_mv * 1000, 4096);
175 data->read_channel = i2c_smbus_read_word_swapped;
176 } else {
177 data->lsb_resol = DIV_ROUND_CLOSEST(data->vref_mv * 1000, 256);
178 data->read_channel = i2c_smbus_read_byte_data;
179 }
Vivien Didelot46d78462012-10-03 16:54:07 -0400180
181 data->cmd_byte = data->ext_vref ? ADS7828_CMD_PD1 : ADS7828_CMD_PD3;
182 if (!data->diff_input)
183 data->cmd_byte |= ADS7828_CMD_SD_SE;
184
Jean Delvare7347cb32008-07-16 19:30:10 +0200185 i2c_set_clientdata(client, data);
Steve Hardy5812f922008-01-22 23:00:02 +0000186 mutex_init(&data->update_lock);
187
Steve Hardy5812f922008-01-22 23:00:02 +0000188 err = sysfs_create_group(&client->dev.kobj, &ads7828_group);
189 if (err)
Guenter Roeck34e3f7f2012-06-02 09:58:00 -0700190 return err;
Steve Hardy5812f922008-01-22 23:00:02 +0000191
192 data->hwmon_dev = hwmon_device_register(&client->dev);
193 if (IS_ERR(data->hwmon_dev)) {
194 err = PTR_ERR(data->hwmon_dev);
Vivien Didelot46d78462012-10-03 16:54:07 -0400195 goto error;
Steve Hardy5812f922008-01-22 23:00:02 +0000196 }
197
198 return 0;
199
Vivien Didelot46d78462012-10-03 16:54:07 -0400200error:
Steve Hardy5812f922008-01-22 23:00:02 +0000201 sysfs_remove_group(&client->dev.kobj, &ads7828_group);
Steve Hardy5812f922008-01-22 23:00:02 +0000202 return err;
203}
204
Vivien Didelot46d78462012-10-03 16:54:07 -0400205static const struct i2c_device_id ads7828_device_ids[] = {
Guillaume Roguez0962e0f2012-10-03 16:54:08 -0400206 { "ads7828", ads7828 },
207 { "ads7830", ads7830 },
Vivien Didelot46d78462012-10-03 16:54:07 -0400208 { }
209};
210MODULE_DEVICE_TABLE(i2c, ads7828_device_ids);
Steve Hardy5812f922008-01-22 23:00:02 +0000211
Vivien Didelot46d78462012-10-03 16:54:07 -0400212static struct i2c_driver ads7828_driver = {
213 .driver = {
214 .name = "ads7828",
215 },
Steve Hardy5812f922008-01-22 23:00:02 +0000216
Vivien Didelot46d78462012-10-03 16:54:07 -0400217 .id_table = ads7828_device_ids,
218 .probe = ads7828_probe,
219 .remove = ads7828_remove,
220};
Steve Hardy5812f922008-01-22 23:00:02 +0000221
Vivien Didelot46d78462012-10-03 16:54:07 -0400222module_i2c_driver(ads7828_driver);
Steve Hardy5812f922008-01-22 23:00:02 +0000223
Steve Hardy5812f922008-01-22 23:00:02 +0000224MODULE_LICENSE("GPL");
Vivien Didelot46d78462012-10-03 16:54:07 -0400225MODULE_AUTHOR("Steve Hardy <shardy@redhat.com>");
Guillaume Roguez0962e0f2012-10-03 16:54:08 -0400226MODULE_DESCRIPTION("Driver for TI ADS7828 A/D converter and compatibles");