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 (1 << 7)
49 #define AD7746_CAPSETUP_CIN2 (1 << 6) /* AD7746 only */
50 #define AD7746_CAPSETUP_CAPDIFF (1 << 5)
51 #define AD7746_CAPSETUP_CACHOP (1 << 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 (1 << 4)
60 #define AD7746_VTSETUP_VTSHORT (1 << 1)
61 #define AD7746_VTSETUP_VTCHOP (1 << 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(x) ((x) << 6)
74 #define AD7746_CONF_CAPFS(x) ((x) << 3)
75 #define AD7746_CONF_MODE_IDLE (0 << 0)
76 #define AD7746_CONF_MODE_CONT_CONV (1 << 0)
77 #define AD7746_CONF_MODE_SINGLE_CONV (2 << 0)
78 #define AD7746_CONF_MODE_PWRDN (3 << 0)
79 #define AD7746_CONF_MODE_OFFS_CAL (5 << 0)
80 #define AD7746_CONF_MODE_GAIN_CAL (6 << 0)
82 /* CAPDAC Register Bit Designations (AD7746_REG_CAPDACx) */
83 #define AD7746_CAPDAC_DACEN (1 << 7)
84 #define AD7746_CAPDAC_DACP(x) ((x) & 0x7F)
87 * struct ad7746_chip_info - chip specific information
90 struct ad7746_chip_info {
91 struct i2c_client *client;
93 * Capacitive channel digital filter setup;
94 * conversion time/update rate setup per channel
105 } data ____cacheline_aligned;
119 static const struct iio_chan_spec ad7746_channels[] = {
124 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
125 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
126 .address = AD7746_REG_VT_DATA_HIGH << 8 |
127 AD7746_VTSETUP_VTMD_EXT_VIN,
133 .extend_name = "supply",
134 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
135 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
136 .address = AD7746_REG_VT_DATA_HIGH << 8 |
137 AD7746_VTSETUP_VTMD_VDD_MON,
143 .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED),
144 .address = AD7746_REG_VT_DATA_HIGH << 8 |
145 AD7746_VTSETUP_VTMD_INT_TEMP,
151 .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED),
152 .address = AD7746_REG_VT_DATA_HIGH << 8 |
153 AD7746_VTSETUP_VTMD_EXT_TEMP,
156 .type = IIO_CAPACITANCE,
159 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
160 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
161 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
162 BIT(IIO_CHAN_INFO_SCALE),
163 .address = AD7746_REG_CAP_DATA_HIGH << 8,
166 .type = IIO_CAPACITANCE,
171 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
172 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
173 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
174 BIT(IIO_CHAN_INFO_SCALE),
175 .address = AD7746_REG_CAP_DATA_HIGH << 8 |
176 AD7746_CAPSETUP_CAPDIFF
179 .type = IIO_CAPACITANCE,
182 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
183 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
184 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
185 BIT(IIO_CHAN_INFO_SCALE),
186 .address = AD7746_REG_CAP_DATA_HIGH << 8 |
187 AD7746_CAPSETUP_CIN2,
190 .type = IIO_CAPACITANCE,
195 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
196 BIT(IIO_CHAN_INFO_CALIBSCALE) | BIT(IIO_CHAN_INFO_OFFSET),
197 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBBIAS) |
198 BIT(IIO_CHAN_INFO_SCALE),
199 .address = AD7746_REG_CAP_DATA_HIGH << 8 |
200 AD7746_CAPSETUP_CAPDIFF | AD7746_CAPSETUP_CIN2,
204 /* Values are Update Rate (Hz), Conversion Time (ms) + 1*/
205 static const unsigned char ad7746_vt_filter_rate_table[][2] = {
206 {50, 20 + 1}, {31, 32 + 1}, {16, 62 + 1}, {8, 122 + 1},
209 static const unsigned char ad7746_cap_filter_rate_table[][2] = {
210 {91, 11 + 1}, {84, 12 + 1}, {50, 20 + 1}, {26, 38 + 1},
211 {16, 62 + 1}, {13, 77 + 1}, {11, 92 + 1}, {9, 110 + 1},
214 static int ad7746_select_channel(struct iio_dev *indio_dev,
215 struct iio_chan_spec const *chan)
217 struct ad7746_chip_info *chip = iio_priv(indio_dev);
219 u8 vt_setup, cap_setup;
221 switch (chan->type) {
222 case IIO_CAPACITANCE:
223 cap_setup = (chan->address & 0xFF) | AD7746_CAPSETUP_CAPEN;
224 vt_setup = chip->vt_setup & ~AD7746_VTSETUP_VTEN;
225 delay = ad7746_cap_filter_rate_table[(chip->config >> 3) &
228 if (chip->capdac_set != chan->channel) {
229 ret = i2c_smbus_write_byte_data(chip->client,
231 chip->capdac[chan->channel][0]);
234 ret = i2c_smbus_write_byte_data(chip->client,
236 chip->capdac[chan->channel][1]);
240 chip->capdac_set = chan->channel;
245 vt_setup = (chan->address & 0xFF) | AD7746_VTSETUP_VTEN;
246 cap_setup = chip->cap_setup & ~AD7746_CAPSETUP_CAPEN;
247 delay = ad7746_cap_filter_rate_table[(chip->config >> 6) &
254 if (chip->cap_setup != cap_setup) {
255 ret = i2c_smbus_write_byte_data(chip->client,
256 AD7746_REG_CAP_SETUP,
261 chip->cap_setup = cap_setup;
264 if (chip->vt_setup != vt_setup) {
265 ret = i2c_smbus_write_byte_data(chip->client,
271 chip->vt_setup = vt_setup;
277 static inline ssize_t ad7746_start_calib(struct device *dev,
278 struct device_attribute *attr,
283 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
284 struct ad7746_chip_info *chip = iio_priv(indio_dev);
286 int ret, timeout = 10;
288 ret = strtobool(buf, &doit);
295 mutex_lock(&indio_dev->mlock);
296 regval |= chip->config;
297 ret = i2c_smbus_write_byte_data(chip->client, AD7746_REG_CFG, regval);
299 mutex_unlock(&indio_dev->mlock);
305 ret = i2c_smbus_read_byte_data(chip->client, AD7746_REG_CFG);
307 mutex_unlock(&indio_dev->mlock);
310 } while ((ret == regval) && timeout--);
312 mutex_unlock(&indio_dev->mlock);
317 static ssize_t ad7746_start_offset_calib(struct device *dev,
318 struct device_attribute *attr,
322 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
323 int ret = ad7746_select_channel(indio_dev,
324 &ad7746_channels[to_iio_dev_attr(attr)->address]);
328 return ad7746_start_calib(dev, attr, buf, len,
329 AD7746_CONF_MODE_OFFS_CAL);
332 static ssize_t ad7746_start_gain_calib(struct device *dev,
333 struct device_attribute *attr,
337 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
338 int ret = ad7746_select_channel(indio_dev,
339 &ad7746_channels[to_iio_dev_attr(attr)->address]);
343 return ad7746_start_calib(dev, attr, buf, len,
344 AD7746_CONF_MODE_GAIN_CAL);
347 static IIO_DEVICE_ATTR(in_capacitance0_calibbias_calibration,
348 S_IWUSR, NULL, ad7746_start_offset_calib, CIN1);
349 static IIO_DEVICE_ATTR(in_capacitance1_calibbias_calibration,
350 S_IWUSR, NULL, ad7746_start_offset_calib, CIN2);
351 static IIO_DEVICE_ATTR(in_capacitance0_calibscale_calibration,
352 S_IWUSR, NULL, ad7746_start_gain_calib, CIN1);
353 static IIO_DEVICE_ATTR(in_capacitance1_calibscale_calibration,
354 S_IWUSR, NULL, ad7746_start_gain_calib, CIN2);
355 static IIO_DEVICE_ATTR(in_voltage0_calibscale_calibration,
356 S_IWUSR, NULL, ad7746_start_gain_calib, VIN);
358 static ssize_t ad7746_show_cap_filter_rate_setup(struct device *dev,
359 struct device_attribute *attr,
362 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
363 struct ad7746_chip_info *chip = iio_priv(indio_dev);
365 return sprintf(buf, "%d\n", ad7746_cap_filter_rate_table[
366 (chip->config >> 3) & 0x7][0]);
369 static ssize_t ad7746_store_cap_filter_rate_setup(struct device *dev,
370 struct device_attribute *attr,
374 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
375 struct ad7746_chip_info *chip = iio_priv(indio_dev);
379 ret = kstrtou8(buf, 10, &data);
383 for (i = 0; i < ARRAY_SIZE(ad7746_cap_filter_rate_table); i++)
384 if (data >= ad7746_cap_filter_rate_table[i][0])
387 if (i >= ARRAY_SIZE(ad7746_cap_filter_rate_table))
388 i = ARRAY_SIZE(ad7746_cap_filter_rate_table) - 1;
390 mutex_lock(&indio_dev->mlock);
391 chip->config &= ~AD7746_CONF_CAPFS(0x7);
392 chip->config |= AD7746_CONF_CAPFS(i);
393 mutex_unlock(&indio_dev->mlock);
398 static ssize_t ad7746_show_vt_filter_rate_setup(struct device *dev,
399 struct device_attribute *attr,
402 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
403 struct ad7746_chip_info *chip = iio_priv(indio_dev);
405 return sprintf(buf, "%d\n", ad7746_vt_filter_rate_table[
406 (chip->config >> 6) & 0x3][0]);
409 static ssize_t ad7746_store_vt_filter_rate_setup(struct device *dev,
410 struct device_attribute *attr,
414 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
415 struct ad7746_chip_info *chip = iio_priv(indio_dev);
419 ret = kstrtou8(buf, 10, &data);
423 for (i = 0; i < ARRAY_SIZE(ad7746_vt_filter_rate_table); i++)
424 if (data >= ad7746_vt_filter_rate_table[i][0])
427 if (i >= ARRAY_SIZE(ad7746_vt_filter_rate_table))
428 i = ARRAY_SIZE(ad7746_vt_filter_rate_table) - 1;
430 mutex_lock(&indio_dev->mlock);
431 chip->config &= ~AD7746_CONF_VTFS(0x3);
432 chip->config |= AD7746_CONF_VTFS(i);
433 mutex_unlock(&indio_dev->mlock);
438 static IIO_DEVICE_ATTR(in_capacitance_sampling_frequency,
439 S_IRUGO | S_IWUSR, ad7746_show_cap_filter_rate_setup,
440 ad7746_store_cap_filter_rate_setup, 0);
442 static IIO_DEVICE_ATTR(in_voltage_sampling_frequency,
443 S_IRUGO | S_IWUSR, ad7746_show_vt_filter_rate_setup,
444 ad7746_store_vt_filter_rate_setup, 0);
446 static IIO_CONST_ATTR(in_voltage_sampling_frequency_available, "50 31 16 8");
447 static IIO_CONST_ATTR(in_capacitance_sampling_frequency_available,
448 "91 84 50 26 16 13 11 9");
450 static struct attribute *ad7746_attributes[] = {
451 &iio_dev_attr_in_capacitance_sampling_frequency.dev_attr.attr,
452 &iio_dev_attr_in_voltage_sampling_frequency.dev_attr.attr,
453 &iio_dev_attr_in_capacitance0_calibbias_calibration.dev_attr.attr,
454 &iio_dev_attr_in_capacitance0_calibscale_calibration.dev_attr.attr,
455 &iio_dev_attr_in_capacitance1_calibscale_calibration.dev_attr.attr,
456 &iio_dev_attr_in_capacitance1_calibbias_calibration.dev_attr.attr,
457 &iio_dev_attr_in_voltage0_calibscale_calibration.dev_attr.attr,
458 &iio_const_attr_in_voltage_sampling_frequency_available.dev_attr.attr,
459 &iio_const_attr_in_capacitance_sampling_frequency_available.
464 static const struct attribute_group ad7746_attribute_group = {
465 .attrs = ad7746_attributes,
468 static int ad7746_write_raw(struct iio_dev *indio_dev,
469 struct iio_chan_spec const *chan,
474 struct ad7746_chip_info *chip = iio_priv(indio_dev);
477 mutex_lock(&indio_dev->mlock);
480 case IIO_CHAN_INFO_CALIBSCALE:
486 val = (val2 * 1024) / 15625;
488 switch (chan->type) {
489 case IIO_CAPACITANCE:
490 reg = AD7746_REG_CAP_GAINH;
493 reg = AD7746_REG_VOLT_GAINH;
500 ret = i2c_smbus_write_word_data(chip->client, reg, swab16(val));
506 case IIO_CHAN_INFO_CALIBBIAS:
507 if ((val < 0) | (val > 0xFFFF)) {
511 ret = i2c_smbus_write_word_data(chip->client,
512 AD7746_REG_CAP_OFFH, swab16(val));
518 case IIO_CHAN_INFO_OFFSET:
519 if ((val < 0) | (val > 43008000)) { /* 21pF */
525 * CAPDAC Scale = 21pF_typ / 127
526 * CIN Scale = 8.192pF / 2^24
527 * Offset Scale = CAPDAC Scale / CIN Scale = 338646
532 chip->capdac[chan->channel][chan->differential] = (val > 0 ?
533 AD7746_CAPDAC_DACP(val) | AD7746_CAPDAC_DACEN : 0);
535 ret = i2c_smbus_write_byte_data(chip->client,
537 chip->capdac[chan->channel][0]);
540 ret = i2c_smbus_write_byte_data(chip->client,
542 chip->capdac[chan->channel][1]);
546 chip->capdac_set = chan->channel;
555 mutex_unlock(&indio_dev->mlock);
559 static int ad7746_read_raw(struct iio_dev *indio_dev,
560 struct iio_chan_spec const *chan,
564 struct ad7746_chip_info *chip = iio_priv(indio_dev);
568 mutex_lock(&indio_dev->mlock);
571 case IIO_CHAN_INFO_RAW:
572 case IIO_CHAN_INFO_PROCESSED:
573 ret = ad7746_select_channel(indio_dev, chan);
578 regval = chip->config | AD7746_CONF_MODE_SINGLE_CONV;
579 ret = i2c_smbus_write_byte_data(chip->client, AD7746_REG_CFG,
585 /* Now read the actual register */
587 ret = i2c_smbus_read_i2c_block_data(chip->client,
588 chan->address >> 8, 3, &chip->data.d8[1]);
593 *val = (be32_to_cpu(chip->data.d32) & 0xFFFFFF) - 0x800000;
595 switch (chan->type) {
598 * temperature in milli degrees Celsius
599 * T = ((*val / 2048) - 4096) * 1000
601 *val = (*val * 125) / 256;
604 if (chan->channel == 1) /* supply_raw*/
613 case IIO_CHAN_INFO_CALIBSCALE:
614 switch (chan->type) {
615 case IIO_CAPACITANCE:
616 reg = AD7746_REG_CAP_GAINH;
619 reg = AD7746_REG_VOLT_GAINH;
626 ret = i2c_smbus_read_word_data(chip->client, reg);
629 /* 1 + gain_val / 2^16 */
631 *val2 = (15625 * swab16(ret)) / 1024;
633 ret = IIO_VAL_INT_PLUS_MICRO;
635 case IIO_CHAN_INFO_CALIBBIAS:
636 ret = i2c_smbus_read_word_data(chip->client,
637 AD7746_REG_CAP_OFFH);
644 case IIO_CHAN_INFO_OFFSET:
645 *val = AD7746_CAPDAC_DACP(chip->capdac[chan->channel]
646 [chan->differential]) * 338646;
650 case IIO_CHAN_INFO_SCALE:
651 switch (chan->type) {
652 case IIO_CAPACITANCE:
656 ret = IIO_VAL_INT_PLUS_NANO;
662 ret = IIO_VAL_FRACTIONAL_LOG2;
674 mutex_unlock(&indio_dev->mlock);
678 static const struct iio_info ad7746_info = {
679 .attrs = &ad7746_attribute_group,
680 .read_raw = &ad7746_read_raw,
681 .write_raw = &ad7746_write_raw,
682 .driver_module = THIS_MODULE,
686 * device probe and remove
689 static int ad7746_probe(struct i2c_client *client,
690 const struct i2c_device_id *id)
692 struct ad7746_platform_data *pdata = client->dev.platform_data;
693 struct ad7746_chip_info *chip;
694 struct iio_dev *indio_dev;
696 unsigned char regval = 0;
698 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*chip));
701 chip = iio_priv(indio_dev);
702 /* this is only used for device removal purposes */
703 i2c_set_clientdata(client, indio_dev);
705 chip->client = client;
706 chip->capdac_set = -1;
708 /* Establish that the iio_dev is a child of the i2c device */
709 indio_dev->name = id->name;
710 indio_dev->dev.parent = &client->dev;
711 indio_dev->info = &ad7746_info;
712 indio_dev->channels = ad7746_channels;
713 if (id->driver_data == 7746)
714 indio_dev->num_channels = ARRAY_SIZE(ad7746_channels);
716 indio_dev->num_channels = ARRAY_SIZE(ad7746_channels) - 2;
717 indio_dev->num_channels = ARRAY_SIZE(ad7746_channels);
718 indio_dev->modes = INDIO_DIRECT_MODE;
721 if (pdata->exca_en) {
722 if (pdata->exca_inv_en)
723 regval |= AD7746_EXCSETUP_NEXCA;
725 regval |= AD7746_EXCSETUP_EXCA;
728 if (pdata->excb_en) {
729 if (pdata->excb_inv_en)
730 regval |= AD7746_EXCSETUP_NEXCB;
732 regval |= AD7746_EXCSETUP_EXCB;
735 regval |= AD7746_EXCSETUP_EXCLVL(pdata->exclvl);
737 dev_warn(&client->dev, "No platform data? using default\n");
738 regval = AD7746_EXCSETUP_EXCA | AD7746_EXCSETUP_EXCB |
739 AD7746_EXCSETUP_EXCLVL(3);
742 ret = i2c_smbus_write_byte_data(chip->client,
743 AD7746_REG_EXC_SETUP, regval);
747 ret = devm_iio_device_register(indio_dev->dev.parent, indio_dev);
754 static const struct i2c_device_id ad7746_id[] = {
761 MODULE_DEVICE_TABLE(i2c, ad7746_id);
763 static struct i2c_driver ad7746_driver = {
765 .name = KBUILD_MODNAME,
767 .probe = ad7746_probe,
768 .id_table = ad7746_id,
770 module_i2c_driver(ad7746_driver);
772 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
773 MODULE_DESCRIPTION("Analog Devices AD7746/5/7 capacitive sensor driver");
774 MODULE_LICENSE("GPL v2");