2 * AD7746 capacitive sensor driver supporting AD7745, AD7746 and AD7747
4 * Copyright 2011 Analog Devices Inc.
6 * Licensed under the GPL-2.
9 #include <linux/interrupt.h>
10 #include <linux/device.h>
11 #include <linux/kernel.h>
12 #include <linux/slab.h>
13 #include <linux/sysfs.h>
14 #include <linux/i2c.h>
15 #include <linux/delay.h>
16 #include <linux/module.h>
17 #include <linux/stat.h>
19 #include <linux/iio/iio.h>
20 #include <linux/iio/sysfs.h>
25 * AD7746 Register Definition
28 #define AD7746_REG_STATUS 0
29 #define AD7746_REG_CAP_DATA_HIGH 1
30 #define AD7746_REG_VT_DATA_HIGH 4
31 #define AD7746_REG_CAP_SETUP 7
32 #define AD7746_REG_VT_SETUP 8
33 #define AD7746_REG_EXC_SETUP 9
34 #define AD7746_REG_CFG 10
35 #define AD7746_REG_CAPDACA 11
36 #define AD7746_REG_CAPDACB 12
37 #define AD7746_REG_CAP_OFFH 13
38 #define AD7746_REG_CAP_GAINH 15
39 #define AD7746_REG_VOLT_GAINH 17
41 /* Status Register Bit Designations (AD7746_REG_STATUS) */
42 #define AD7746_STATUS_EXCERR BIT(3)
43 #define AD7746_STATUS_RDY BIT(2)
44 #define AD7746_STATUS_RDYVT BIT(1)
45 #define AD7746_STATUS_RDYCAP BIT(0)
47 /* Capacitive Channel Setup Register Bit Designations (AD7746_REG_CAP_SETUP) */
48 #define AD7746_CAPSETUP_CAPEN BIT(7)
49 #define AD7746_CAPSETUP_CIN2 BIT(6) /* AD7746 only */
50 #define AD7746_CAPSETUP_CAPDIFF BIT(5)
51 #define AD7746_CAPSETUP_CACHOP BIT(0)
53 /* Voltage/Temperature Setup Register Bit Designations (AD7746_REG_VT_SETUP) */
54 #define AD7746_VTSETUP_VTEN (1 << 7)
55 #define AD7746_VTSETUP_VTMD_INT_TEMP (0 << 5)
56 #define AD7746_VTSETUP_VTMD_EXT_TEMP (1 << 5)
57 #define AD7746_VTSETUP_VTMD_VDD_MON (2 << 5)
58 #define AD7746_VTSETUP_VTMD_EXT_VIN (3 << 5)
59 #define AD7746_VTSETUP_EXTREF BIT(4)
60 #define AD7746_VTSETUP_VTSHORT BIT(1)
61 #define AD7746_VTSETUP_VTCHOP BIT(0)
63 /* Excitation Setup Register Bit Designations (AD7746_REG_EXC_SETUP) */
64 #define AD7746_EXCSETUP_CLKCTRL BIT(7)
65 #define AD7746_EXCSETUP_EXCON BIT(6)
66 #define AD7746_EXCSETUP_EXCB BIT(5)
67 #define AD7746_EXCSETUP_NEXCB BIT(4)
68 #define AD7746_EXCSETUP_EXCA BIT(3)
69 #define AD7746_EXCSETUP_NEXCA BIT(2)
70 #define AD7746_EXCSETUP_EXCLVL(x) (((x) & 0x3) << 0)
72 /* Config Register Bit Designations (AD7746_REG_CFG) */
73 #define AD7746_CONF_VTFS_SHIFT 6
74 #define AD7746_CONF_CAPFS_SHIFT 3
75 #define AD7746_CONF_VTFS_MASK GENMASK(7, 6)
76 #define AD7746_CONF_CAPFS_MASK GENMASK(5, 3)
77 #define AD7746_CONF_MODE_IDLE (0 << 0)
78 #define AD7746_CONF_MODE_CONT_CONV (1 << 0)
79 #define AD7746_CONF_MODE_SINGLE_CONV (2 << 0)
80 #define AD7746_CONF_MODE_PWRDN (3 << 0)
81 #define AD7746_CONF_MODE_OFFS_CAL (5 << 0)
82 #define AD7746_CONF_MODE_GAIN_CAL (6 << 0)
84 /* CAPDAC Register Bit Designations (AD7746_REG_CAPDACx) */
85 #define AD7746_CAPDAC_DACEN BIT(7)
86 #define AD7746_CAPDAC_DACP(x) ((x) & 0x7F)
89 * struct ad7746_chip_info - chip specific information
92 struct ad7746_chip_info {
93 struct i2c_client *client;
94 struct mutex lock; /* protect sensor state */
96 * Capacitive channel digital filter setup;
97 * conversion time/update rate setup per channel
108 } data ____cacheline_aligned;
122 static const struct iio_chan_spec ad7746_channels[] = {
127 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
128 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) |
129 BIT(IIO_CHAN_INFO_SAMP_FREQ),
130 .address = AD7746_REG_VT_DATA_HIGH << 8 |
131 AD7746_VTSETUP_VTMD_EXT_VIN,
137 .extend_name = "supply",
138 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
139 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) |
140 BIT(IIO_CHAN_INFO_SAMP_FREQ),
141 .address = AD7746_REG_VT_DATA_HIGH << 8 |
142 AD7746_VTSETUP_VTMD_VDD_MON,
148 .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED),
149 .address = AD7746_REG_VT_DATA_HIGH << 8 |
150 AD7746_VTSETUP_VTMD_INT_TEMP,
156 .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED),
157 .address = AD7746_REG_VT_DATA_HIGH << 8 |
158 AD7746_VTSETUP_VTMD_EXT_TEMP,
161 .type = IIO_CAPACITANCE,
164 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
165 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
166 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
167 BIT(IIO_CHAN_INFO_SCALE) | BIT(IIO_CHAN_INFO_SAMP_FREQ),
168 .address = AD7746_REG_CAP_DATA_HIGH << 8,
171 .type = IIO_CAPACITANCE,
176 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
177 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
178 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
179 BIT(IIO_CHAN_INFO_SCALE) | BIT(IIO_CHAN_INFO_SAMP_FREQ),
180 .address = AD7746_REG_CAP_DATA_HIGH << 8 |
181 AD7746_CAPSETUP_CAPDIFF
184 .type = IIO_CAPACITANCE,
187 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
188 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
189 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
190 BIT(IIO_CHAN_INFO_SCALE) | BIT(IIO_CHAN_INFO_SAMP_FREQ),
191 .address = AD7746_REG_CAP_DATA_HIGH << 8 |
192 AD7746_CAPSETUP_CIN2,
195 .type = IIO_CAPACITANCE,
200 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
201 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
202 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
203 BIT(IIO_CHAN_INFO_SCALE) | BIT(IIO_CHAN_INFO_SAMP_FREQ),
204 .address = AD7746_REG_CAP_DATA_HIGH << 8 |
205 AD7746_CAPSETUP_CAPDIFF | AD7746_CAPSETUP_CIN2,
209 /* Values are Update Rate (Hz), Conversion Time (ms) + 1*/
210 static const unsigned char ad7746_vt_filter_rate_table[][2] = {
211 {50, 20 + 1}, {31, 32 + 1}, {16, 62 + 1}, {8, 122 + 1},
214 static const unsigned char ad7746_cap_filter_rate_table[][2] = {
215 {91, 11 + 1}, {84, 12 + 1}, {50, 20 + 1}, {26, 38 + 1},
216 {16, 62 + 1}, {13, 77 + 1}, {11, 92 + 1}, {9, 110 + 1},
219 static int ad7746_select_channel(struct iio_dev *indio_dev,
220 struct iio_chan_spec const *chan)
222 struct ad7746_chip_info *chip = iio_priv(indio_dev);
224 u8 vt_setup, cap_setup;
226 switch (chan->type) {
227 case IIO_CAPACITANCE:
228 cap_setup = (chan->address & 0xFF) | AD7746_CAPSETUP_CAPEN;
229 vt_setup = chip->vt_setup & ~AD7746_VTSETUP_VTEN;
230 idx = (chip->config & AD7746_CONF_CAPFS_MASK) >>
231 AD7746_CONF_CAPFS_SHIFT;
232 delay = ad7746_cap_filter_rate_table[idx][1];
234 if (chip->capdac_set != chan->channel) {
235 ret = i2c_smbus_write_byte_data(chip->client,
237 chip->capdac[chan->channel][0]);
240 ret = i2c_smbus_write_byte_data(chip->client,
242 chip->capdac[chan->channel][1]);
246 chip->capdac_set = chan->channel;
251 vt_setup = (chan->address & 0xFF) | AD7746_VTSETUP_VTEN;
252 cap_setup = chip->cap_setup & ~AD7746_CAPSETUP_CAPEN;
253 idx = (chip->config & AD7746_CONF_VTFS_MASK) >>
254 AD7746_CONF_VTFS_SHIFT;
255 delay = ad7746_cap_filter_rate_table[idx][1];
261 if (chip->cap_setup != cap_setup) {
262 ret = i2c_smbus_write_byte_data(chip->client,
263 AD7746_REG_CAP_SETUP,
268 chip->cap_setup = cap_setup;
271 if (chip->vt_setup != vt_setup) {
272 ret = i2c_smbus_write_byte_data(chip->client,
278 chip->vt_setup = vt_setup;
284 static inline ssize_t ad7746_start_calib(struct device *dev,
285 struct device_attribute *attr,
290 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
291 struct ad7746_chip_info *chip = iio_priv(indio_dev);
293 int ret, timeout = 10;
295 ret = strtobool(buf, &doit);
302 mutex_lock(&chip->lock);
303 regval |= chip->config;
304 ret = i2c_smbus_write_byte_data(chip->client, AD7746_REG_CFG, regval);
306 mutex_unlock(&chip->lock);
312 ret = i2c_smbus_read_byte_data(chip->client, AD7746_REG_CFG);
314 mutex_unlock(&chip->lock);
317 } while ((ret == regval) && timeout--);
319 mutex_unlock(&chip->lock);
324 static ssize_t ad7746_start_offset_calib(struct device *dev,
325 struct device_attribute *attr,
329 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
330 int ret = ad7746_select_channel(indio_dev,
331 &ad7746_channels[to_iio_dev_attr(attr)->address]);
335 return ad7746_start_calib(dev, attr, buf, len,
336 AD7746_CONF_MODE_OFFS_CAL);
339 static ssize_t ad7746_start_gain_calib(struct device *dev,
340 struct device_attribute *attr,
344 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
345 int ret = ad7746_select_channel(indio_dev,
346 &ad7746_channels[to_iio_dev_attr(attr)->address]);
350 return ad7746_start_calib(dev, attr, buf, len,
351 AD7746_CONF_MODE_GAIN_CAL);
354 static IIO_DEVICE_ATTR(in_capacitance0_calibbias_calibration,
355 0200, NULL, ad7746_start_offset_calib, CIN1);
356 static IIO_DEVICE_ATTR(in_capacitance1_calibbias_calibration,
357 0200, NULL, ad7746_start_offset_calib, CIN2);
358 static IIO_DEVICE_ATTR(in_capacitance0_calibscale_calibration,
359 0200, NULL, ad7746_start_gain_calib, CIN1);
360 static IIO_DEVICE_ATTR(in_capacitance1_calibscale_calibration,
361 0200, NULL, ad7746_start_gain_calib, CIN2);
362 static IIO_DEVICE_ATTR(in_voltage0_calibscale_calibration,
363 0200, NULL, ad7746_start_gain_calib, VIN);
365 static int ad7746_store_cap_filter_rate_setup(struct ad7746_chip_info *chip,
370 for (i = 0; i < ARRAY_SIZE(ad7746_cap_filter_rate_table); i++)
371 if (val >= ad7746_cap_filter_rate_table[i][0])
374 if (i >= ARRAY_SIZE(ad7746_cap_filter_rate_table))
375 i = ARRAY_SIZE(ad7746_cap_filter_rate_table) - 1;
377 chip->config &= ~AD7746_CONF_CAPFS_MASK;
378 chip->config |= i << AD7746_CONF_CAPFS_SHIFT;
383 static int ad7746_store_vt_filter_rate_setup(struct ad7746_chip_info *chip,
388 for (i = 0; i < ARRAY_SIZE(ad7746_vt_filter_rate_table); i++)
389 if (val >= ad7746_vt_filter_rate_table[i][0])
392 if (i >= ARRAY_SIZE(ad7746_vt_filter_rate_table))
393 i = ARRAY_SIZE(ad7746_vt_filter_rate_table) - 1;
395 chip->config &= ~AD7746_CONF_VTFS_MASK;
396 chip->config |= i << AD7746_CONF_VTFS_SHIFT;
401 static IIO_CONST_ATTR(in_voltage_sampling_frequency_available, "50 31 16 8");
402 static IIO_CONST_ATTR(in_capacitance_sampling_frequency_available,
403 "91 84 50 26 16 13 11 9");
405 static struct attribute *ad7746_attributes[] = {
406 &iio_dev_attr_in_capacitance0_calibbias_calibration.dev_attr.attr,
407 &iio_dev_attr_in_capacitance0_calibscale_calibration.dev_attr.attr,
408 &iio_dev_attr_in_capacitance1_calibscale_calibration.dev_attr.attr,
409 &iio_dev_attr_in_capacitance1_calibbias_calibration.dev_attr.attr,
410 &iio_dev_attr_in_voltage0_calibscale_calibration.dev_attr.attr,
411 &iio_const_attr_in_voltage_sampling_frequency_available.dev_attr.attr,
412 &iio_const_attr_in_capacitance_sampling_frequency_available.
417 static const struct attribute_group ad7746_attribute_group = {
418 .attrs = ad7746_attributes,
421 static int ad7746_write_raw(struct iio_dev *indio_dev,
422 struct iio_chan_spec const *chan,
427 struct ad7746_chip_info *chip = iio_priv(indio_dev);
430 mutex_lock(&chip->lock);
433 case IIO_CHAN_INFO_CALIBSCALE:
439 val = (val2 * 1024) / 15625;
441 switch (chan->type) {
442 case IIO_CAPACITANCE:
443 reg = AD7746_REG_CAP_GAINH;
446 reg = AD7746_REG_VOLT_GAINH;
453 ret = i2c_smbus_write_word_data(chip->client, reg, swab16(val));
459 case IIO_CHAN_INFO_CALIBBIAS:
460 if ((val < 0) | (val > 0xFFFF)) {
464 ret = i2c_smbus_write_word_data(chip->client,
465 AD7746_REG_CAP_OFFH, swab16(val));
471 case IIO_CHAN_INFO_OFFSET:
472 if ((val < 0) | (val > 43008000)) { /* 21pF */
478 * CAPDAC Scale = 21pF_typ / 127
479 * CIN Scale = 8.192pF / 2^24
480 * Offset Scale = CAPDAC Scale / CIN Scale = 338646
485 chip->capdac[chan->channel][chan->differential] = val > 0 ?
486 AD7746_CAPDAC_DACP(val) | AD7746_CAPDAC_DACEN : 0;
488 ret = i2c_smbus_write_byte_data(chip->client,
490 chip->capdac[chan->channel][0]);
493 ret = i2c_smbus_write_byte_data(chip->client,
495 chip->capdac[chan->channel][1]);
499 chip->capdac_set = chan->channel;
503 case IIO_CHAN_INFO_SAMP_FREQ:
509 switch (chan->type) {
510 case IIO_CAPACITANCE:
511 ret = ad7746_store_cap_filter_rate_setup(chip, val);
514 ret = ad7746_store_vt_filter_rate_setup(chip, val);
525 mutex_unlock(&chip->lock);
529 static int ad7746_read_raw(struct iio_dev *indio_dev,
530 struct iio_chan_spec const *chan,
534 struct ad7746_chip_info *chip = iio_priv(indio_dev);
538 mutex_lock(&chip->lock);
541 case IIO_CHAN_INFO_RAW:
542 case IIO_CHAN_INFO_PROCESSED:
543 ret = ad7746_select_channel(indio_dev, chan);
548 regval = chip->config | AD7746_CONF_MODE_SINGLE_CONV;
549 ret = i2c_smbus_write_byte_data(chip->client, AD7746_REG_CFG,
555 /* Now read the actual register */
557 ret = i2c_smbus_read_i2c_block_data(chip->client,
558 chan->address >> 8, 3, &chip->data.d8[1]);
563 *val = (be32_to_cpu(chip->data.d32) & 0xFFFFFF) - 0x800000;
565 switch (chan->type) {
568 * temperature in milli degrees Celsius
569 * T = ((*val / 2048) - 4096) * 1000
571 *val = (*val * 125) / 256;
574 if (chan->channel == 1) /* supply_raw*/
583 case IIO_CHAN_INFO_CALIBSCALE:
584 switch (chan->type) {
585 case IIO_CAPACITANCE:
586 reg = AD7746_REG_CAP_GAINH;
589 reg = AD7746_REG_VOLT_GAINH;
596 ret = i2c_smbus_read_word_data(chip->client, reg);
599 /* 1 + gain_val / 2^16 */
601 *val2 = (15625 * swab16(ret)) / 1024;
603 ret = IIO_VAL_INT_PLUS_MICRO;
605 case IIO_CHAN_INFO_CALIBBIAS:
606 ret = i2c_smbus_read_word_data(chip->client,
607 AD7746_REG_CAP_OFFH);
614 case IIO_CHAN_INFO_OFFSET:
615 *val = AD7746_CAPDAC_DACP(chip->capdac[chan->channel]
616 [chan->differential]) * 338646;
620 case IIO_CHAN_INFO_SCALE:
621 switch (chan->type) {
622 case IIO_CAPACITANCE:
626 ret = IIO_VAL_INT_PLUS_NANO;
632 ret = IIO_VAL_FRACTIONAL_LOG2;
640 case IIO_CHAN_INFO_SAMP_FREQ:
641 switch (chan->type) {
642 case IIO_CAPACITANCE:
643 idx = (chip->config & AD7746_CONF_CAPFS_MASK) >>
644 AD7746_CONF_CAPFS_SHIFT;
645 *val = ad7746_cap_filter_rate_table[idx][0];
649 idx = (chip->config & AD7746_CONF_VTFS_MASK) >>
650 AD7746_CONF_VTFS_SHIFT;
651 *val = ad7746_vt_filter_rate_table[idx][0];
662 mutex_unlock(&chip->lock);
666 static const struct iio_info ad7746_info = {
667 .attrs = &ad7746_attribute_group,
668 .read_raw = ad7746_read_raw,
669 .write_raw = ad7746_write_raw,
670 .driver_module = THIS_MODULE,
674 * device probe and remove
677 static int ad7746_probe(struct i2c_client *client,
678 const struct i2c_device_id *id)
680 struct ad7746_platform_data *pdata = client->dev.platform_data;
681 struct ad7746_chip_info *chip;
682 struct iio_dev *indio_dev;
684 unsigned char regval = 0;
686 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*chip));
689 chip = iio_priv(indio_dev);
690 mutex_init(&chip->lock);
691 /* this is only used for device removal purposes */
692 i2c_set_clientdata(client, indio_dev);
694 chip->client = client;
695 chip->capdac_set = -1;
697 /* Establish that the iio_dev is a child of the i2c device */
698 indio_dev->name = id->name;
699 indio_dev->dev.parent = &client->dev;
700 indio_dev->info = &ad7746_info;
701 indio_dev->channels = ad7746_channels;
702 if (id->driver_data == 7746)
703 indio_dev->num_channels = ARRAY_SIZE(ad7746_channels);
705 indio_dev->num_channels = ARRAY_SIZE(ad7746_channels) - 2;
706 indio_dev->modes = INDIO_DIRECT_MODE;
709 if (pdata->exca_en) {
710 if (pdata->exca_inv_en)
711 regval |= AD7746_EXCSETUP_NEXCA;
713 regval |= AD7746_EXCSETUP_EXCA;
716 if (pdata->excb_en) {
717 if (pdata->excb_inv_en)
718 regval |= AD7746_EXCSETUP_NEXCB;
720 regval |= AD7746_EXCSETUP_EXCB;
723 regval |= AD7746_EXCSETUP_EXCLVL(pdata->exclvl);
725 dev_warn(&client->dev, "No platform data? using default\n");
726 regval = AD7746_EXCSETUP_EXCA | AD7746_EXCSETUP_EXCB |
727 AD7746_EXCSETUP_EXCLVL(3);
730 ret = i2c_smbus_write_byte_data(chip->client,
731 AD7746_REG_EXC_SETUP, regval);
735 ret = devm_iio_device_register(indio_dev->dev.parent, indio_dev);
742 static const struct i2c_device_id ad7746_id[] = {
749 MODULE_DEVICE_TABLE(i2c, ad7746_id);
751 static struct i2c_driver ad7746_driver = {
753 .name = KBUILD_MODNAME,
755 .probe = ad7746_probe,
756 .id_table = ad7746_id,
758 module_i2c_driver(ad7746_driver);
760 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
761 MODULE_DESCRIPTION("Analog Devices AD7746/5/7 capacitive sensor driver");
762 MODULE_LICENSE("GPL v2");