ds1803.c 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Maxim Integrated DS1803 and similar digital potentiometer driver
  4. * Copyright (c) 2016 Slawomir Stepien
  5. * Copyright (c) 2022 Jagath Jog J
  6. *
  7. * Datasheet: https://datasheets.maximintegrated.com/en/ds/DS1803.pdf
  8. * Datasheet: https://datasheets.maximintegrated.com/en/ds/DS3502.pdf
  9. *
  10. * DEVID #Wipers #Positions Resistor Opts (kOhm) i2c address
  11. * ds1803 2 256 10, 50, 100 0101xxx
  12. * ds3502 1 128 10 01010xx
  13. */
  14. #include <linux/err.h>
  15. #include <linux/export.h>
  16. #include <linux/i2c.h>
  17. #include <linux/iio/iio.h>
  18. #include <linux/module.h>
  19. #include <linux/mod_devicetable.h>
  20. #include <linux/property.h>
  21. #define DS1803_WIPER_0 0xA9
  22. #define DS1803_WIPER_1 0xAA
  23. #define DS3502_WR_IVR 0x00
  24. enum ds1803_type {
  25. DS1803_010,
  26. DS1803_050,
  27. DS1803_100,
  28. DS3502,
  29. };
  30. struct ds1803_cfg {
  31. int wipers;
  32. int avail[3];
  33. int kohms;
  34. const struct iio_chan_spec *channels;
  35. u8 num_channels;
  36. int (*read)(struct iio_dev *indio_dev,
  37. struct iio_chan_spec const *chan, int *val);
  38. };
  39. struct ds1803_data {
  40. struct i2c_client *client;
  41. const struct ds1803_cfg *cfg;
  42. };
  43. #define DS1803_CHANNEL(ch, addr) { \
  44. .type = IIO_RESISTANCE, \
  45. .indexed = 1, \
  46. .output = 1, \
  47. .channel = (ch), \
  48. .address = (addr), \
  49. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
  50. .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
  51. .info_mask_shared_by_type_available = BIT(IIO_CHAN_INFO_RAW), \
  52. }
  53. static const struct iio_chan_spec ds1803_channels[] = {
  54. DS1803_CHANNEL(0, DS1803_WIPER_0),
  55. DS1803_CHANNEL(1, DS1803_WIPER_1),
  56. };
  57. static const struct iio_chan_spec ds3502_channels[] = {
  58. DS1803_CHANNEL(0, DS3502_WR_IVR),
  59. };
  60. static int ds1803_read(struct iio_dev *indio_dev,
  61. struct iio_chan_spec const *chan,
  62. int *val)
  63. {
  64. struct ds1803_data *data = iio_priv(indio_dev);
  65. int ret;
  66. u8 result[ARRAY_SIZE(ds1803_channels)];
  67. ret = i2c_master_recv(data->client, result, indio_dev->num_channels);
  68. if (ret < 0)
  69. return ret;
  70. *val = result[chan->channel];
  71. return ret;
  72. }
  73. static int ds3502_read(struct iio_dev *indio_dev,
  74. struct iio_chan_spec const *chan,
  75. int *val)
  76. {
  77. struct ds1803_data *data = iio_priv(indio_dev);
  78. int ret;
  79. ret = i2c_smbus_read_byte_data(data->client, chan->address);
  80. if (ret < 0)
  81. return ret;
  82. *val = ret;
  83. return ret;
  84. }
  85. static const struct ds1803_cfg ds1803_cfg[] = {
  86. [DS1803_010] = {
  87. .wipers = 2,
  88. .avail = { 0, 1, 255 },
  89. .kohms = 10,
  90. .channels = ds1803_channels,
  91. .num_channels = ARRAY_SIZE(ds1803_channels),
  92. .read = ds1803_read,
  93. },
  94. [DS1803_050] = {
  95. .wipers = 2,
  96. .avail = { 0, 1, 255 },
  97. .kohms = 50,
  98. .channels = ds1803_channels,
  99. .num_channels = ARRAY_SIZE(ds1803_channels),
  100. .read = ds1803_read,
  101. },
  102. [DS1803_100] = {
  103. .wipers = 2,
  104. .avail = { 0, 1, 255 },
  105. .kohms = 100,
  106. .channels = ds1803_channels,
  107. .num_channels = ARRAY_SIZE(ds1803_channels),
  108. .read = ds1803_read,
  109. },
  110. [DS3502] = {
  111. .wipers = 1,
  112. .avail = { 0, 1, 127 },
  113. .kohms = 10,
  114. .channels = ds3502_channels,
  115. .num_channels = ARRAY_SIZE(ds3502_channels),
  116. .read = ds3502_read,
  117. },
  118. };
  119. static int ds1803_read_raw(struct iio_dev *indio_dev,
  120. struct iio_chan_spec const *chan,
  121. int *val, int *val2, long mask)
  122. {
  123. struct ds1803_data *data = iio_priv(indio_dev);
  124. int ret;
  125. switch (mask) {
  126. case IIO_CHAN_INFO_RAW:
  127. ret = data->cfg->read(indio_dev, chan, val);
  128. if (ret < 0)
  129. return ret;
  130. return IIO_VAL_INT;
  131. case IIO_CHAN_INFO_SCALE:
  132. *val = 1000 * data->cfg->kohms;
  133. *val2 = data->cfg->avail[2]; /* Max wiper position */
  134. return IIO_VAL_FRACTIONAL;
  135. }
  136. return -EINVAL;
  137. }
  138. static int ds1803_write_raw(struct iio_dev *indio_dev,
  139. struct iio_chan_spec const *chan,
  140. int val, int val2, long mask)
  141. {
  142. struct ds1803_data *data = iio_priv(indio_dev);
  143. u8 addr = chan->address;
  144. int max_pos = data->cfg->avail[2];
  145. if (val2 != 0)
  146. return -EINVAL;
  147. switch (mask) {
  148. case IIO_CHAN_INFO_RAW:
  149. if (val > max_pos || val < 0)
  150. return -EINVAL;
  151. break;
  152. default:
  153. return -EINVAL;
  154. }
  155. return i2c_smbus_write_byte_data(data->client, addr, val);
  156. }
  157. static int ds1803_read_avail(struct iio_dev *indio_dev,
  158. struct iio_chan_spec const *chan,
  159. const int **vals, int *type,
  160. int *length, long mask)
  161. {
  162. struct ds1803_data *data = iio_priv(indio_dev);
  163. switch (mask) {
  164. case IIO_CHAN_INFO_RAW:
  165. *vals = data->cfg->avail;
  166. *length = ARRAY_SIZE(data->cfg->avail);
  167. *type = IIO_VAL_INT;
  168. return IIO_AVAIL_RANGE;
  169. }
  170. return -EINVAL;
  171. }
  172. static const struct iio_info ds1803_info = {
  173. .read_raw = ds1803_read_raw,
  174. .write_raw = ds1803_write_raw,
  175. .read_avail = ds1803_read_avail,
  176. };
  177. static int ds1803_probe(struct i2c_client *client, const struct i2c_device_id *id)
  178. {
  179. struct device *dev = &client->dev;
  180. struct ds1803_data *data;
  181. struct iio_dev *indio_dev;
  182. indio_dev = devm_iio_device_alloc(dev, sizeof(*data));
  183. if (!indio_dev)
  184. return -ENOMEM;
  185. i2c_set_clientdata(client, indio_dev);
  186. data = iio_priv(indio_dev);
  187. data->client = client;
  188. data->cfg = device_get_match_data(dev);
  189. if (!data->cfg)
  190. data->cfg = &ds1803_cfg[id->driver_data];
  191. indio_dev->info = &ds1803_info;
  192. indio_dev->channels = data->cfg->channels;
  193. indio_dev->num_channels = data->cfg->num_channels;
  194. indio_dev->name = client->name;
  195. return devm_iio_device_register(dev, indio_dev);
  196. }
  197. static const struct of_device_id ds1803_dt_ids[] = {
  198. { .compatible = "maxim,ds1803-010", .data = &ds1803_cfg[DS1803_010] },
  199. { .compatible = "maxim,ds1803-050", .data = &ds1803_cfg[DS1803_050] },
  200. { .compatible = "maxim,ds1803-100", .data = &ds1803_cfg[DS1803_100] },
  201. { .compatible = "maxim,ds3502", .data = &ds1803_cfg[DS3502] },
  202. {}
  203. };
  204. MODULE_DEVICE_TABLE(of, ds1803_dt_ids);
  205. static const struct i2c_device_id ds1803_id[] = {
  206. { "ds1803-010", DS1803_010 },
  207. { "ds1803-050", DS1803_050 },
  208. { "ds1803-100", DS1803_100 },
  209. { "ds3502", DS3502 },
  210. {}
  211. };
  212. MODULE_DEVICE_TABLE(i2c, ds1803_id);
  213. static struct i2c_driver ds1803_driver = {
  214. .driver = {
  215. .name = "ds1803",
  216. .of_match_table = ds1803_dt_ids,
  217. },
  218. .probe = ds1803_probe,
  219. .id_table = ds1803_id,
  220. };
  221. module_i2c_driver(ds1803_driver);
  222. MODULE_AUTHOR("Slawomir Stepien <[email protected]>");
  223. MODULE_AUTHOR("Jagath Jog J <[email protected]>");
  224. MODULE_DESCRIPTION("DS1803 digital potentiometer");
  225. MODULE_LICENSE("GPL v2");