ad5592r-base.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * AD5592R Digital <-> Analog converters driver
  4. *
  5. * Copyright 2014-2016 Analog Devices Inc.
  6. * Author: Paul Cercueil <[email protected]>
  7. */
  8. #include <linux/bitops.h>
  9. #include <linux/delay.h>
  10. #include <linux/iio/iio.h>
  11. #include <linux/module.h>
  12. #include <linux/mutex.h>
  13. #include <linux/regulator/consumer.h>
  14. #include <linux/gpio/consumer.h>
  15. #include <linux/gpio/driver.h>
  16. #include <linux/property.h>
  17. #include <dt-bindings/iio/adi,ad5592r.h>
  18. #include "ad5592r-base.h"
  19. static int ad5592r_gpio_get(struct gpio_chip *chip, unsigned offset)
  20. {
  21. struct ad5592r_state *st = gpiochip_get_data(chip);
  22. int ret = 0;
  23. u8 val;
  24. mutex_lock(&st->gpio_lock);
  25. if (st->gpio_out & BIT(offset))
  26. val = st->gpio_val;
  27. else
  28. ret = st->ops->gpio_read(st, &val);
  29. mutex_unlock(&st->gpio_lock);
  30. if (ret < 0)
  31. return ret;
  32. return !!(val & BIT(offset));
  33. }
  34. static void ad5592r_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
  35. {
  36. struct ad5592r_state *st = gpiochip_get_data(chip);
  37. mutex_lock(&st->gpio_lock);
  38. if (value)
  39. st->gpio_val |= BIT(offset);
  40. else
  41. st->gpio_val &= ~BIT(offset);
  42. st->ops->reg_write(st, AD5592R_REG_GPIO_SET, st->gpio_val);
  43. mutex_unlock(&st->gpio_lock);
  44. }
  45. static int ad5592r_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
  46. {
  47. struct ad5592r_state *st = gpiochip_get_data(chip);
  48. int ret;
  49. mutex_lock(&st->gpio_lock);
  50. st->gpio_out &= ~BIT(offset);
  51. st->gpio_in |= BIT(offset);
  52. ret = st->ops->reg_write(st, AD5592R_REG_GPIO_OUT_EN, st->gpio_out);
  53. if (ret < 0)
  54. goto err_unlock;
  55. ret = st->ops->reg_write(st, AD5592R_REG_GPIO_IN_EN, st->gpio_in);
  56. err_unlock:
  57. mutex_unlock(&st->gpio_lock);
  58. return ret;
  59. }
  60. static int ad5592r_gpio_direction_output(struct gpio_chip *chip,
  61. unsigned offset, int value)
  62. {
  63. struct ad5592r_state *st = gpiochip_get_data(chip);
  64. int ret;
  65. mutex_lock(&st->gpio_lock);
  66. if (value)
  67. st->gpio_val |= BIT(offset);
  68. else
  69. st->gpio_val &= ~BIT(offset);
  70. st->gpio_in &= ~BIT(offset);
  71. st->gpio_out |= BIT(offset);
  72. ret = st->ops->reg_write(st, AD5592R_REG_GPIO_SET, st->gpio_val);
  73. if (ret < 0)
  74. goto err_unlock;
  75. ret = st->ops->reg_write(st, AD5592R_REG_GPIO_OUT_EN, st->gpio_out);
  76. if (ret < 0)
  77. goto err_unlock;
  78. ret = st->ops->reg_write(st, AD5592R_REG_GPIO_IN_EN, st->gpio_in);
  79. err_unlock:
  80. mutex_unlock(&st->gpio_lock);
  81. return ret;
  82. }
  83. static int ad5592r_gpio_request(struct gpio_chip *chip, unsigned offset)
  84. {
  85. struct ad5592r_state *st = gpiochip_get_data(chip);
  86. if (!(st->gpio_map & BIT(offset))) {
  87. dev_err(st->dev, "GPIO %d is reserved by alternate function\n",
  88. offset);
  89. return -ENODEV;
  90. }
  91. return 0;
  92. }
  93. static int ad5592r_gpio_init(struct ad5592r_state *st)
  94. {
  95. if (!st->gpio_map)
  96. return 0;
  97. st->gpiochip.label = dev_name(st->dev);
  98. st->gpiochip.base = -1;
  99. st->gpiochip.ngpio = 8;
  100. st->gpiochip.parent = st->dev;
  101. st->gpiochip.can_sleep = true;
  102. st->gpiochip.direction_input = ad5592r_gpio_direction_input;
  103. st->gpiochip.direction_output = ad5592r_gpio_direction_output;
  104. st->gpiochip.get = ad5592r_gpio_get;
  105. st->gpiochip.set = ad5592r_gpio_set;
  106. st->gpiochip.request = ad5592r_gpio_request;
  107. st->gpiochip.owner = THIS_MODULE;
  108. mutex_init(&st->gpio_lock);
  109. return gpiochip_add_data(&st->gpiochip, st);
  110. }
  111. static void ad5592r_gpio_cleanup(struct ad5592r_state *st)
  112. {
  113. if (st->gpio_map)
  114. gpiochip_remove(&st->gpiochip);
  115. }
  116. static int ad5592r_reset(struct ad5592r_state *st)
  117. {
  118. struct gpio_desc *gpio;
  119. gpio = devm_gpiod_get_optional(st->dev, "reset", GPIOD_OUT_LOW);
  120. if (IS_ERR(gpio))
  121. return PTR_ERR(gpio);
  122. if (gpio) {
  123. udelay(1);
  124. gpiod_set_value(gpio, 1);
  125. } else {
  126. mutex_lock(&st->lock);
  127. /* Writing this magic value resets the device */
  128. st->ops->reg_write(st, AD5592R_REG_RESET, 0xdac);
  129. mutex_unlock(&st->lock);
  130. }
  131. udelay(250);
  132. return 0;
  133. }
  134. static int ad5592r_get_vref(struct ad5592r_state *st)
  135. {
  136. int ret;
  137. if (st->reg) {
  138. ret = regulator_get_voltage(st->reg);
  139. if (ret < 0)
  140. return ret;
  141. return ret / 1000;
  142. } else {
  143. return 2500;
  144. }
  145. }
  146. static int ad5592r_set_channel_modes(struct ad5592r_state *st)
  147. {
  148. const struct ad5592r_rw_ops *ops = st->ops;
  149. int ret;
  150. unsigned i;
  151. u8 pulldown = 0, tristate = 0, dac = 0, adc = 0;
  152. u16 read_back;
  153. for (i = 0; i < st->num_channels; i++) {
  154. switch (st->channel_modes[i]) {
  155. case CH_MODE_DAC:
  156. dac |= BIT(i);
  157. break;
  158. case CH_MODE_ADC:
  159. adc |= BIT(i);
  160. break;
  161. case CH_MODE_DAC_AND_ADC:
  162. dac |= BIT(i);
  163. adc |= BIT(i);
  164. break;
  165. case CH_MODE_GPIO:
  166. st->gpio_map |= BIT(i);
  167. st->gpio_in |= BIT(i); /* Default to input */
  168. break;
  169. case CH_MODE_UNUSED:
  170. default:
  171. switch (st->channel_offstate[i]) {
  172. case CH_OFFSTATE_OUT_TRISTATE:
  173. tristate |= BIT(i);
  174. break;
  175. case CH_OFFSTATE_OUT_LOW:
  176. st->gpio_out |= BIT(i);
  177. break;
  178. case CH_OFFSTATE_OUT_HIGH:
  179. st->gpio_out |= BIT(i);
  180. st->gpio_val |= BIT(i);
  181. break;
  182. case CH_OFFSTATE_PULLDOWN:
  183. default:
  184. pulldown |= BIT(i);
  185. break;
  186. }
  187. }
  188. }
  189. mutex_lock(&st->lock);
  190. /* Pull down unused pins to GND */
  191. ret = ops->reg_write(st, AD5592R_REG_PULLDOWN, pulldown);
  192. if (ret)
  193. goto err_unlock;
  194. ret = ops->reg_write(st, AD5592R_REG_TRISTATE, tristate);
  195. if (ret)
  196. goto err_unlock;
  197. /* Configure pins that we use */
  198. ret = ops->reg_write(st, AD5592R_REG_DAC_EN, dac);
  199. if (ret)
  200. goto err_unlock;
  201. ret = ops->reg_write(st, AD5592R_REG_ADC_EN, adc);
  202. if (ret)
  203. goto err_unlock;
  204. ret = ops->reg_write(st, AD5592R_REG_GPIO_SET, st->gpio_val);
  205. if (ret)
  206. goto err_unlock;
  207. ret = ops->reg_write(st, AD5592R_REG_GPIO_OUT_EN, st->gpio_out);
  208. if (ret)
  209. goto err_unlock;
  210. ret = ops->reg_write(st, AD5592R_REG_GPIO_IN_EN, st->gpio_in);
  211. if (ret)
  212. goto err_unlock;
  213. /* Verify that we can read back at least one register */
  214. ret = ops->reg_read(st, AD5592R_REG_ADC_EN, &read_back);
  215. if (!ret && (read_back & 0xff) != adc)
  216. ret = -EIO;
  217. err_unlock:
  218. mutex_unlock(&st->lock);
  219. return ret;
  220. }
  221. static int ad5592r_reset_channel_modes(struct ad5592r_state *st)
  222. {
  223. int i;
  224. for (i = 0; i < ARRAY_SIZE(st->channel_modes); i++)
  225. st->channel_modes[i] = CH_MODE_UNUSED;
  226. return ad5592r_set_channel_modes(st);
  227. }
  228. static int ad5592r_write_raw(struct iio_dev *iio_dev,
  229. struct iio_chan_spec const *chan, int val, int val2, long mask)
  230. {
  231. struct ad5592r_state *st = iio_priv(iio_dev);
  232. int ret;
  233. switch (mask) {
  234. case IIO_CHAN_INFO_RAW:
  235. if (val >= (1 << chan->scan_type.realbits) || val < 0)
  236. return -EINVAL;
  237. if (!chan->output)
  238. return -EINVAL;
  239. mutex_lock(&st->lock);
  240. ret = st->ops->write_dac(st, chan->channel, val);
  241. if (!ret)
  242. st->cached_dac[chan->channel] = val;
  243. mutex_unlock(&st->lock);
  244. return ret;
  245. case IIO_CHAN_INFO_SCALE:
  246. if (chan->type == IIO_VOLTAGE) {
  247. bool gain;
  248. if (val == st->scale_avail[0][0] &&
  249. val2 == st->scale_avail[0][1])
  250. gain = false;
  251. else if (val == st->scale_avail[1][0] &&
  252. val2 == st->scale_avail[1][1])
  253. gain = true;
  254. else
  255. return -EINVAL;
  256. mutex_lock(&st->lock);
  257. ret = st->ops->reg_read(st, AD5592R_REG_CTRL,
  258. &st->cached_gp_ctrl);
  259. if (ret < 0) {
  260. mutex_unlock(&st->lock);
  261. return ret;
  262. }
  263. if (chan->output) {
  264. if (gain)
  265. st->cached_gp_ctrl |=
  266. AD5592R_REG_CTRL_DAC_RANGE;
  267. else
  268. st->cached_gp_ctrl &=
  269. ~AD5592R_REG_CTRL_DAC_RANGE;
  270. } else {
  271. if (gain)
  272. st->cached_gp_ctrl |=
  273. AD5592R_REG_CTRL_ADC_RANGE;
  274. else
  275. st->cached_gp_ctrl &=
  276. ~AD5592R_REG_CTRL_ADC_RANGE;
  277. }
  278. ret = st->ops->reg_write(st, AD5592R_REG_CTRL,
  279. st->cached_gp_ctrl);
  280. mutex_unlock(&st->lock);
  281. return ret;
  282. }
  283. break;
  284. default:
  285. return -EINVAL;
  286. }
  287. return 0;
  288. }
  289. static int ad5592r_read_raw(struct iio_dev *iio_dev,
  290. struct iio_chan_spec const *chan,
  291. int *val, int *val2, long m)
  292. {
  293. struct ad5592r_state *st = iio_priv(iio_dev);
  294. u16 read_val;
  295. int ret, mult;
  296. switch (m) {
  297. case IIO_CHAN_INFO_RAW:
  298. if (!chan->output) {
  299. mutex_lock(&st->lock);
  300. ret = st->ops->read_adc(st, chan->channel, &read_val);
  301. mutex_unlock(&st->lock);
  302. if (ret)
  303. return ret;
  304. if ((read_val >> 12 & 0x7) != (chan->channel & 0x7)) {
  305. dev_err(st->dev, "Error while reading channel %u\n",
  306. chan->channel);
  307. return -EIO;
  308. }
  309. read_val &= GENMASK(11, 0);
  310. } else {
  311. mutex_lock(&st->lock);
  312. read_val = st->cached_dac[chan->channel];
  313. mutex_unlock(&st->lock);
  314. }
  315. dev_dbg(st->dev, "Channel %u read: 0x%04hX\n",
  316. chan->channel, read_val);
  317. *val = (int) read_val;
  318. return IIO_VAL_INT;
  319. case IIO_CHAN_INFO_SCALE:
  320. *val = ad5592r_get_vref(st);
  321. if (chan->type == IIO_TEMP) {
  322. s64 tmp = *val * (3767897513LL / 25LL);
  323. *val = div_s64_rem(tmp, 1000000000LL, val2);
  324. return IIO_VAL_INT_PLUS_MICRO;
  325. }
  326. mutex_lock(&st->lock);
  327. if (chan->output)
  328. mult = !!(st->cached_gp_ctrl &
  329. AD5592R_REG_CTRL_DAC_RANGE);
  330. else
  331. mult = !!(st->cached_gp_ctrl &
  332. AD5592R_REG_CTRL_ADC_RANGE);
  333. mutex_unlock(&st->lock);
  334. *val *= ++mult;
  335. *val2 = chan->scan_type.realbits;
  336. return IIO_VAL_FRACTIONAL_LOG2;
  337. case IIO_CHAN_INFO_OFFSET:
  338. ret = ad5592r_get_vref(st);
  339. mutex_lock(&st->lock);
  340. if (st->cached_gp_ctrl & AD5592R_REG_CTRL_ADC_RANGE)
  341. *val = (-34365 * 25) / ret;
  342. else
  343. *val = (-75365 * 25) / ret;
  344. mutex_unlock(&st->lock);
  345. return IIO_VAL_INT;
  346. default:
  347. return -EINVAL;
  348. }
  349. }
  350. static int ad5592r_write_raw_get_fmt(struct iio_dev *indio_dev,
  351. struct iio_chan_spec const *chan, long mask)
  352. {
  353. switch (mask) {
  354. case IIO_CHAN_INFO_SCALE:
  355. return IIO_VAL_INT_PLUS_NANO;
  356. default:
  357. return IIO_VAL_INT_PLUS_MICRO;
  358. }
  359. return -EINVAL;
  360. }
  361. static const struct iio_info ad5592r_info = {
  362. .read_raw = ad5592r_read_raw,
  363. .write_raw = ad5592r_write_raw,
  364. .write_raw_get_fmt = ad5592r_write_raw_get_fmt,
  365. };
  366. static ssize_t ad5592r_show_scale_available(struct iio_dev *iio_dev,
  367. uintptr_t private,
  368. const struct iio_chan_spec *chan,
  369. char *buf)
  370. {
  371. struct ad5592r_state *st = iio_priv(iio_dev);
  372. return sprintf(buf, "%d.%09u %d.%09u\n",
  373. st->scale_avail[0][0], st->scale_avail[0][1],
  374. st->scale_avail[1][0], st->scale_avail[1][1]);
  375. }
  376. static const struct iio_chan_spec_ext_info ad5592r_ext_info[] = {
  377. {
  378. .name = "scale_available",
  379. .read = ad5592r_show_scale_available,
  380. .shared = IIO_SHARED_BY_TYPE,
  381. },
  382. {},
  383. };
  384. static void ad5592r_setup_channel(struct iio_dev *iio_dev,
  385. struct iio_chan_spec *chan, bool output, unsigned id)
  386. {
  387. chan->type = IIO_VOLTAGE;
  388. chan->indexed = 1;
  389. chan->output = output;
  390. chan->channel = id;
  391. chan->info_mask_separate = BIT(IIO_CHAN_INFO_RAW);
  392. chan->info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE);
  393. chan->scan_type.sign = 'u';
  394. chan->scan_type.realbits = 12;
  395. chan->scan_type.storagebits = 16;
  396. chan->ext_info = ad5592r_ext_info;
  397. }
  398. static int ad5592r_alloc_channels(struct iio_dev *iio_dev)
  399. {
  400. struct ad5592r_state *st = iio_priv(iio_dev);
  401. unsigned i, curr_channel = 0,
  402. num_channels = st->num_channels;
  403. struct iio_chan_spec *channels;
  404. struct fwnode_handle *child;
  405. u32 reg, tmp;
  406. int ret;
  407. device_for_each_child_node(st->dev, child) {
  408. ret = fwnode_property_read_u32(child, "reg", &reg);
  409. if (ret || reg >= ARRAY_SIZE(st->channel_modes))
  410. continue;
  411. ret = fwnode_property_read_u32(child, "adi,mode", &tmp);
  412. if (!ret)
  413. st->channel_modes[reg] = tmp;
  414. ret = fwnode_property_read_u32(child, "adi,off-state", &tmp);
  415. if (!ret)
  416. st->channel_offstate[reg] = tmp;
  417. }
  418. channels = devm_kcalloc(st->dev,
  419. 1 + 2 * num_channels, sizeof(*channels),
  420. GFP_KERNEL);
  421. if (!channels)
  422. return -ENOMEM;
  423. for (i = 0; i < num_channels; i++) {
  424. switch (st->channel_modes[i]) {
  425. case CH_MODE_DAC:
  426. ad5592r_setup_channel(iio_dev, &channels[curr_channel],
  427. true, i);
  428. curr_channel++;
  429. break;
  430. case CH_MODE_ADC:
  431. ad5592r_setup_channel(iio_dev, &channels[curr_channel],
  432. false, i);
  433. curr_channel++;
  434. break;
  435. case CH_MODE_DAC_AND_ADC:
  436. ad5592r_setup_channel(iio_dev, &channels[curr_channel],
  437. true, i);
  438. curr_channel++;
  439. ad5592r_setup_channel(iio_dev, &channels[curr_channel],
  440. false, i);
  441. curr_channel++;
  442. break;
  443. default:
  444. continue;
  445. }
  446. }
  447. channels[curr_channel].type = IIO_TEMP;
  448. channels[curr_channel].channel = 8;
  449. channels[curr_channel].info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
  450. BIT(IIO_CHAN_INFO_SCALE) |
  451. BIT(IIO_CHAN_INFO_OFFSET);
  452. curr_channel++;
  453. iio_dev->num_channels = curr_channel;
  454. iio_dev->channels = channels;
  455. return 0;
  456. }
  457. static void ad5592r_init_scales(struct ad5592r_state *st, int vref_mV)
  458. {
  459. s64 tmp = (s64)vref_mV * 1000000000LL >> 12;
  460. st->scale_avail[0][0] =
  461. div_s64_rem(tmp, 1000000000LL, &st->scale_avail[0][1]);
  462. st->scale_avail[1][0] =
  463. div_s64_rem(tmp * 2, 1000000000LL, &st->scale_avail[1][1]);
  464. }
  465. int ad5592r_probe(struct device *dev, const char *name,
  466. const struct ad5592r_rw_ops *ops)
  467. {
  468. struct iio_dev *iio_dev;
  469. struct ad5592r_state *st;
  470. int ret;
  471. iio_dev = devm_iio_device_alloc(dev, sizeof(*st));
  472. if (!iio_dev)
  473. return -ENOMEM;
  474. st = iio_priv(iio_dev);
  475. st->dev = dev;
  476. st->ops = ops;
  477. st->num_channels = 8;
  478. dev_set_drvdata(dev, iio_dev);
  479. st->reg = devm_regulator_get_optional(dev, "vref");
  480. if (IS_ERR(st->reg)) {
  481. if ((PTR_ERR(st->reg) != -ENODEV) && dev_fwnode(dev))
  482. return PTR_ERR(st->reg);
  483. st->reg = NULL;
  484. } else {
  485. ret = regulator_enable(st->reg);
  486. if (ret)
  487. return ret;
  488. }
  489. iio_dev->name = name;
  490. iio_dev->info = &ad5592r_info;
  491. iio_dev->modes = INDIO_DIRECT_MODE;
  492. mutex_init(&st->lock);
  493. ad5592r_init_scales(st, ad5592r_get_vref(st));
  494. ret = ad5592r_reset(st);
  495. if (ret)
  496. goto error_disable_reg;
  497. ret = ops->reg_write(st, AD5592R_REG_PD,
  498. (st->reg == NULL) ? AD5592R_REG_PD_EN_REF : 0);
  499. if (ret)
  500. goto error_disable_reg;
  501. ret = ad5592r_alloc_channels(iio_dev);
  502. if (ret)
  503. goto error_disable_reg;
  504. ret = ad5592r_set_channel_modes(st);
  505. if (ret)
  506. goto error_reset_ch_modes;
  507. ret = iio_device_register(iio_dev);
  508. if (ret)
  509. goto error_reset_ch_modes;
  510. ret = ad5592r_gpio_init(st);
  511. if (ret)
  512. goto error_dev_unregister;
  513. return 0;
  514. error_dev_unregister:
  515. iio_device_unregister(iio_dev);
  516. error_reset_ch_modes:
  517. ad5592r_reset_channel_modes(st);
  518. error_disable_reg:
  519. if (st->reg)
  520. regulator_disable(st->reg);
  521. return ret;
  522. }
  523. EXPORT_SYMBOL_NS_GPL(ad5592r_probe, IIO_AD5592R);
  524. void ad5592r_remove(struct device *dev)
  525. {
  526. struct iio_dev *iio_dev = dev_get_drvdata(dev);
  527. struct ad5592r_state *st = iio_priv(iio_dev);
  528. iio_device_unregister(iio_dev);
  529. ad5592r_reset_channel_modes(st);
  530. ad5592r_gpio_cleanup(st);
  531. if (st->reg)
  532. regulator_disable(st->reg);
  533. }
  534. EXPORT_SYMBOL_NS_GPL(ad5592r_remove, IIO_AD5592R);
  535. MODULE_AUTHOR("Paul Cercueil <[email protected]>");
  536. MODULE_DESCRIPTION("Analog Devices AD5592R multi-channel converters");
  537. MODULE_LICENSE("GPL v2");