ad7780.c 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * AD7170/AD7171 and AD7780/AD7781 SPI ADC driver
  4. *
  5. * Copyright 2011 Analog Devices Inc.
  6. * Copyright 2019 Renato Lui Geh
  7. */
  8. #include <linux/interrupt.h>
  9. #include <linux/device.h>
  10. #include <linux/kernel.h>
  11. #include <linux/slab.h>
  12. #include <linux/sysfs.h>
  13. #include <linux/spi/spi.h>
  14. #include <linux/regulator/consumer.h>
  15. #include <linux/err.h>
  16. #include <linux/sched.h>
  17. #include <linux/gpio/consumer.h>
  18. #include <linux/module.h>
  19. #include <linux/bits.h>
  20. #include <linux/iio/iio.h>
  21. #include <linux/iio/sysfs.h>
  22. #include <linux/iio/adc/ad_sigma_delta.h>
  23. #define AD7780_RDY BIT(7)
  24. #define AD7780_FILTER BIT(6)
  25. #define AD7780_ERR BIT(5)
  26. #define AD7780_ID1 BIT(4)
  27. #define AD7780_ID0 BIT(3)
  28. #define AD7780_GAIN BIT(2)
  29. #define AD7170_ID 0
  30. #define AD7171_ID 1
  31. #define AD7780_ID 1
  32. #define AD7781_ID 0
  33. #define AD7780_ID_MASK (AD7780_ID0 | AD7780_ID1)
  34. #define AD7780_PATTERN_GOOD 1
  35. #define AD7780_PATTERN_MASK GENMASK(1, 0)
  36. #define AD7170_PATTERN_GOOD 5
  37. #define AD7170_PATTERN_MASK GENMASK(2, 0)
  38. #define AD7780_GAIN_MIDPOINT 64
  39. #define AD7780_FILTER_MIDPOINT 13350
  40. static const unsigned int ad778x_gain[2] = { 1, 128 };
  41. static const unsigned int ad778x_odr_avail[2] = { 10000, 16700 };
  42. struct ad7780_chip_info {
  43. struct iio_chan_spec channel;
  44. unsigned int pattern_mask;
  45. unsigned int pattern;
  46. bool is_ad778x;
  47. };
  48. struct ad7780_state {
  49. const struct ad7780_chip_info *chip_info;
  50. struct regulator *reg;
  51. struct gpio_desc *powerdown_gpio;
  52. struct gpio_desc *gain_gpio;
  53. struct gpio_desc *filter_gpio;
  54. unsigned int gain;
  55. unsigned int odr;
  56. unsigned int int_vref_mv;
  57. struct ad_sigma_delta sd;
  58. };
  59. enum ad7780_supported_device_ids {
  60. ID_AD7170,
  61. ID_AD7171,
  62. ID_AD7780,
  63. ID_AD7781,
  64. };
  65. static struct ad7780_state *ad_sigma_delta_to_ad7780(struct ad_sigma_delta *sd)
  66. {
  67. return container_of(sd, struct ad7780_state, sd);
  68. }
  69. static int ad7780_set_mode(struct ad_sigma_delta *sigma_delta,
  70. enum ad_sigma_delta_mode mode)
  71. {
  72. struct ad7780_state *st = ad_sigma_delta_to_ad7780(sigma_delta);
  73. unsigned int val;
  74. switch (mode) {
  75. case AD_SD_MODE_SINGLE:
  76. case AD_SD_MODE_CONTINUOUS:
  77. val = 1;
  78. break;
  79. default:
  80. val = 0;
  81. break;
  82. }
  83. gpiod_set_value(st->powerdown_gpio, val);
  84. return 0;
  85. }
  86. static int ad7780_read_raw(struct iio_dev *indio_dev,
  87. struct iio_chan_spec const *chan,
  88. int *val,
  89. int *val2,
  90. long m)
  91. {
  92. struct ad7780_state *st = iio_priv(indio_dev);
  93. int voltage_uv;
  94. switch (m) {
  95. case IIO_CHAN_INFO_RAW:
  96. return ad_sigma_delta_single_conversion(indio_dev, chan, val);
  97. case IIO_CHAN_INFO_SCALE:
  98. voltage_uv = regulator_get_voltage(st->reg);
  99. if (voltage_uv < 0)
  100. return voltage_uv;
  101. voltage_uv /= 1000;
  102. *val = voltage_uv * st->gain;
  103. *val2 = chan->scan_type.realbits - 1;
  104. st->int_vref_mv = voltage_uv;
  105. return IIO_VAL_FRACTIONAL_LOG2;
  106. case IIO_CHAN_INFO_OFFSET:
  107. *val = -(1 << (chan->scan_type.realbits - 1));
  108. return IIO_VAL_INT;
  109. case IIO_CHAN_INFO_SAMP_FREQ:
  110. *val = st->odr;
  111. return IIO_VAL_INT;
  112. default:
  113. break;
  114. }
  115. return -EINVAL;
  116. }
  117. static int ad7780_write_raw(struct iio_dev *indio_dev,
  118. struct iio_chan_spec const *chan,
  119. int val,
  120. int val2,
  121. long m)
  122. {
  123. struct ad7780_state *st = iio_priv(indio_dev);
  124. const struct ad7780_chip_info *chip_info = st->chip_info;
  125. unsigned long long vref;
  126. unsigned int full_scale, gain;
  127. if (!chip_info->is_ad778x)
  128. return -EINVAL;
  129. switch (m) {
  130. case IIO_CHAN_INFO_SCALE:
  131. if (val != 0)
  132. return -EINVAL;
  133. vref = st->int_vref_mv * 1000000LL;
  134. full_scale = 1 << (chip_info->channel.scan_type.realbits - 1);
  135. gain = DIV_ROUND_CLOSEST_ULL(vref, full_scale);
  136. gain = DIV_ROUND_CLOSEST(gain, val2);
  137. st->gain = gain;
  138. if (gain < AD7780_GAIN_MIDPOINT)
  139. gain = 0;
  140. else
  141. gain = 1;
  142. gpiod_set_value(st->gain_gpio, gain);
  143. break;
  144. case IIO_CHAN_INFO_SAMP_FREQ:
  145. if (1000*val + val2/1000 < AD7780_FILTER_MIDPOINT)
  146. val = 0;
  147. else
  148. val = 1;
  149. st->odr = ad778x_odr_avail[val];
  150. gpiod_set_value(st->filter_gpio, val);
  151. break;
  152. default:
  153. break;
  154. }
  155. return 0;
  156. }
  157. static int ad7780_postprocess_sample(struct ad_sigma_delta *sigma_delta,
  158. unsigned int raw_sample)
  159. {
  160. struct ad7780_state *st = ad_sigma_delta_to_ad7780(sigma_delta);
  161. const struct ad7780_chip_info *chip_info = st->chip_info;
  162. if ((raw_sample & AD7780_ERR) ||
  163. ((raw_sample & chip_info->pattern_mask) != chip_info->pattern))
  164. return -EIO;
  165. if (chip_info->is_ad778x) {
  166. st->gain = ad778x_gain[raw_sample & AD7780_GAIN];
  167. st->odr = ad778x_odr_avail[raw_sample & AD7780_FILTER];
  168. }
  169. return 0;
  170. }
  171. static const struct ad_sigma_delta_info ad7780_sigma_delta_info = {
  172. .set_mode = ad7780_set_mode,
  173. .postprocess_sample = ad7780_postprocess_sample,
  174. .has_registers = false,
  175. .irq_flags = IRQF_TRIGGER_FALLING,
  176. };
  177. #define _AD7780_CHANNEL(_bits, _wordsize, _mask_all) \
  178. { \
  179. .type = IIO_VOLTAGE, \
  180. .indexed = 1, \
  181. .channel = 0, \
  182. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
  183. BIT(IIO_CHAN_INFO_OFFSET), \
  184. .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
  185. .info_mask_shared_by_all = _mask_all, \
  186. .scan_index = 1, \
  187. .scan_type = { \
  188. .sign = 'u', \
  189. .realbits = (_bits), \
  190. .storagebits = 32, \
  191. .shift = (_wordsize) - (_bits), \
  192. .endianness = IIO_BE, \
  193. }, \
  194. }
  195. #define AD7780_CHANNEL(_bits, _wordsize) \
  196. _AD7780_CHANNEL(_bits, _wordsize, BIT(IIO_CHAN_INFO_SAMP_FREQ))
  197. #define AD7170_CHANNEL(_bits, _wordsize) \
  198. _AD7780_CHANNEL(_bits, _wordsize, 0)
  199. static const struct ad7780_chip_info ad7780_chip_info_tbl[] = {
  200. [ID_AD7170] = {
  201. .channel = AD7170_CHANNEL(12, 24),
  202. .pattern = AD7170_PATTERN_GOOD,
  203. .pattern_mask = AD7170_PATTERN_MASK,
  204. .is_ad778x = false,
  205. },
  206. [ID_AD7171] = {
  207. .channel = AD7170_CHANNEL(16, 24),
  208. .pattern = AD7170_PATTERN_GOOD,
  209. .pattern_mask = AD7170_PATTERN_MASK,
  210. .is_ad778x = false,
  211. },
  212. [ID_AD7780] = {
  213. .channel = AD7780_CHANNEL(24, 32),
  214. .pattern = AD7780_PATTERN_GOOD,
  215. .pattern_mask = AD7780_PATTERN_MASK,
  216. .is_ad778x = true,
  217. },
  218. [ID_AD7781] = {
  219. .channel = AD7780_CHANNEL(20, 32),
  220. .pattern = AD7780_PATTERN_GOOD,
  221. .pattern_mask = AD7780_PATTERN_MASK,
  222. .is_ad778x = true,
  223. },
  224. };
  225. static const struct iio_info ad7780_info = {
  226. .read_raw = ad7780_read_raw,
  227. .write_raw = ad7780_write_raw,
  228. };
  229. static int ad7780_init_gpios(struct device *dev, struct ad7780_state *st)
  230. {
  231. int ret;
  232. st->powerdown_gpio = devm_gpiod_get_optional(dev,
  233. "powerdown",
  234. GPIOD_OUT_LOW);
  235. if (IS_ERR(st->powerdown_gpio)) {
  236. ret = PTR_ERR(st->powerdown_gpio);
  237. dev_err(dev, "Failed to request powerdown GPIO: %d\n", ret);
  238. return ret;
  239. }
  240. if (!st->chip_info->is_ad778x)
  241. return 0;
  242. st->gain_gpio = devm_gpiod_get_optional(dev,
  243. "adi,gain",
  244. GPIOD_OUT_HIGH);
  245. if (IS_ERR(st->gain_gpio)) {
  246. ret = PTR_ERR(st->gain_gpio);
  247. dev_err(dev, "Failed to request gain GPIO: %d\n", ret);
  248. return ret;
  249. }
  250. st->filter_gpio = devm_gpiod_get_optional(dev,
  251. "adi,filter",
  252. GPIOD_OUT_HIGH);
  253. if (IS_ERR(st->filter_gpio)) {
  254. ret = PTR_ERR(st->filter_gpio);
  255. dev_err(dev, "Failed to request filter GPIO: %d\n", ret);
  256. return ret;
  257. }
  258. return 0;
  259. }
  260. static void ad7780_reg_disable(void *reg)
  261. {
  262. regulator_disable(reg);
  263. }
  264. static int ad7780_probe(struct spi_device *spi)
  265. {
  266. struct ad7780_state *st;
  267. struct iio_dev *indio_dev;
  268. int ret;
  269. indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
  270. if (!indio_dev)
  271. return -ENOMEM;
  272. st = iio_priv(indio_dev);
  273. st->gain = 1;
  274. ad_sd_init(&st->sd, indio_dev, spi, &ad7780_sigma_delta_info);
  275. st->chip_info =
  276. &ad7780_chip_info_tbl[spi_get_device_id(spi)->driver_data];
  277. indio_dev->name = spi_get_device_id(spi)->name;
  278. indio_dev->modes = INDIO_DIRECT_MODE;
  279. indio_dev->channels = &st->chip_info->channel;
  280. indio_dev->num_channels = 1;
  281. indio_dev->info = &ad7780_info;
  282. ret = ad7780_init_gpios(&spi->dev, st);
  283. if (ret)
  284. return ret;
  285. st->reg = devm_regulator_get(&spi->dev, "avdd");
  286. if (IS_ERR(st->reg))
  287. return PTR_ERR(st->reg);
  288. ret = regulator_enable(st->reg);
  289. if (ret) {
  290. dev_err(&spi->dev, "Failed to enable specified AVdd supply\n");
  291. return ret;
  292. }
  293. ret = devm_add_action_or_reset(&spi->dev, ad7780_reg_disable, st->reg);
  294. if (ret)
  295. return ret;
  296. ret = devm_ad_sd_setup_buffer_and_trigger(&spi->dev, indio_dev);
  297. if (ret)
  298. return ret;
  299. return devm_iio_device_register(&spi->dev, indio_dev);
  300. }
  301. static const struct spi_device_id ad7780_id[] = {
  302. {"ad7170", ID_AD7170},
  303. {"ad7171", ID_AD7171},
  304. {"ad7780", ID_AD7780},
  305. {"ad7781", ID_AD7781},
  306. {}
  307. };
  308. MODULE_DEVICE_TABLE(spi, ad7780_id);
  309. static struct spi_driver ad7780_driver = {
  310. .driver = {
  311. .name = "ad7780",
  312. },
  313. .probe = ad7780_probe,
  314. .id_table = ad7780_id,
  315. };
  316. module_spi_driver(ad7780_driver);
  317. MODULE_AUTHOR("Michael Hennerich <[email protected]>");
  318. MODULE_DESCRIPTION("Analog Devices AD7780 and similar ADCs");
  319. MODULE_LICENSE("GPL v2");
  320. MODULE_IMPORT_NS(IIO_AD_SIGMA_DELTA);