adjd_s311.c 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. /*
  2. * adjd_s311.c - Support for ADJD-S311-CR999 digital color sensor
  3. *
  4. * Copyright (C) 2012 Peter Meerwald <pmeerw@pmeerw.net>
  5. *
  6. * This file is subject to the terms and conditions of version 2 of
  7. * the GNU General Public License. See the file COPYING in the main
  8. * directory of this archive for more details.
  9. *
  10. * driver for ADJD-S311-CR999 digital color sensor (10-bit channels for
  11. * red, green, blue, clear); 7-bit I2C slave address 0x74
  12. *
  13. * limitations: no calibration, no offset mode, no sleep mode
  14. */
  15. #include <linux/module.h>
  16. #include <linux/init.h>
  17. #include <linux/interrupt.h>
  18. #include <linux/i2c.h>
  19. #include <linux/slab.h>
  20. #include <linux/delay.h>
  21. #include <linux/bitmap.h>
  22. #include <linux/err.h>
  23. #include <linux/irq.h>
  24. #include <linux/iio/iio.h>
  25. #include <linux/iio/sysfs.h>
  26. #include <linux/iio/trigger_consumer.h>
  27. #include <linux/iio/buffer.h>
  28. #include <linux/iio/triggered_buffer.h>
  29. #define ADJD_S311_DRV_NAME "adjd_s311"
  30. #define ADJD_S311_CTRL 0x00
  31. #define ADJD_S311_CONFIG 0x01
  32. #define ADJD_S311_CAP_RED 0x06
  33. #define ADJD_S311_CAP_GREEN 0x07
  34. #define ADJD_S311_CAP_BLUE 0x08
  35. #define ADJD_S311_CAP_CLEAR 0x09
  36. #define ADJD_S311_INT_RED 0x0a
  37. #define ADJD_S311_INT_GREEN 0x0c
  38. #define ADJD_S311_INT_BLUE 0x0e
  39. #define ADJD_S311_INT_CLEAR 0x10
  40. #define ADJD_S311_DATA_RED 0x40
  41. #define ADJD_S311_DATA_GREEN 0x42
  42. #define ADJD_S311_DATA_BLUE 0x44
  43. #define ADJD_S311_DATA_CLEAR 0x46
  44. #define ADJD_S311_OFFSET_RED 0x48
  45. #define ADJD_S311_OFFSET_GREEN 0x49
  46. #define ADJD_S311_OFFSET_BLUE 0x4a
  47. #define ADJD_S311_OFFSET_CLEAR 0x4b
  48. #define ADJD_S311_CTRL_GOFS 0x02
  49. #define ADJD_S311_CTRL_GSSR 0x01
  50. #define ADJD_S311_CAP_MASK 0x0f
  51. #define ADJD_S311_INT_MASK 0x0fff
  52. #define ADJD_S311_DATA_MASK 0x03ff
  53. struct adjd_s311_data {
  54. struct i2c_client *client;
  55. u16 *buffer;
  56. };
  57. enum adjd_s311_channel_idx {
  58. IDX_RED, IDX_GREEN, IDX_BLUE, IDX_CLEAR
  59. };
  60. #define ADJD_S311_DATA_REG(chan) (ADJD_S311_DATA_RED + (chan) * 2)
  61. #define ADJD_S311_INT_REG(chan) (ADJD_S311_INT_RED + (chan) * 2)
  62. #define ADJD_S311_CAP_REG(chan) (ADJD_S311_CAP_RED + (chan))
  63. static int adjd_s311_req_data(struct iio_dev *indio_dev)
  64. {
  65. struct adjd_s311_data *data = iio_priv(indio_dev);
  66. int tries = 10;
  67. int ret = i2c_smbus_write_byte_data(data->client, ADJD_S311_CTRL,
  68. ADJD_S311_CTRL_GSSR);
  69. if (ret < 0)
  70. return ret;
  71. while (tries--) {
  72. ret = i2c_smbus_read_byte_data(data->client, ADJD_S311_CTRL);
  73. if (ret < 0)
  74. return ret;
  75. if (!(ret & ADJD_S311_CTRL_GSSR))
  76. break;
  77. msleep(20);
  78. }
  79. if (tries < 0) {
  80. dev_err(&data->client->dev,
  81. "adjd_s311_req_data() failed, data not ready\n");
  82. return -EIO;
  83. }
  84. return 0;
  85. }
  86. static int adjd_s311_read_data(struct iio_dev *indio_dev, u8 reg, int *val)
  87. {
  88. struct adjd_s311_data *data = iio_priv(indio_dev);
  89. int ret = adjd_s311_req_data(indio_dev);
  90. if (ret < 0)
  91. return ret;
  92. ret = i2c_smbus_read_word_data(data->client, reg);
  93. if (ret < 0)
  94. return ret;
  95. *val = ret & ADJD_S311_DATA_MASK;
  96. return 0;
  97. }
  98. static irqreturn_t adjd_s311_trigger_handler(int irq, void *p)
  99. {
  100. struct iio_poll_func *pf = p;
  101. struct iio_dev *indio_dev = pf->indio_dev;
  102. struct adjd_s311_data *data = iio_priv(indio_dev);
  103. s64 time_ns = iio_get_time_ns();
  104. int len = 0;
  105. int i, j = 0;
  106. int ret = adjd_s311_req_data(indio_dev);
  107. if (ret < 0)
  108. goto done;
  109. for_each_set_bit(i, indio_dev->active_scan_mask,
  110. indio_dev->masklength) {
  111. ret = i2c_smbus_read_word_data(data->client,
  112. ADJD_S311_DATA_REG(i));
  113. if (ret < 0)
  114. goto done;
  115. data->buffer[j++] = ret & ADJD_S311_DATA_MASK;
  116. len += 2;
  117. }
  118. if (indio_dev->scan_timestamp)
  119. *(s64 *)((u8 *)data->buffer + ALIGN(len, sizeof(s64)))
  120. = time_ns;
  121. iio_push_to_buffers(indio_dev, (u8 *)data->buffer);
  122. done:
  123. iio_trigger_notify_done(indio_dev->trig);
  124. return IRQ_HANDLED;
  125. }
  126. #define ADJD_S311_CHANNEL(_color, _scan_idx) { \
  127. .type = IIO_INTENSITY, \
  128. .modified = 1, \
  129. .address = (IDX_##_color), \
  130. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
  131. BIT(IIO_CHAN_INFO_HARDWAREGAIN) | \
  132. BIT(IIO_CHAN_INFO_INT_TIME), \
  133. .channel2 = (IIO_MOD_LIGHT_##_color), \
  134. .scan_index = (_scan_idx), \
  135. .scan_type = IIO_ST('u', 10, 16, 0), \
  136. }
  137. static const struct iio_chan_spec adjd_s311_channels[] = {
  138. ADJD_S311_CHANNEL(RED, 0),
  139. ADJD_S311_CHANNEL(GREEN, 1),
  140. ADJD_S311_CHANNEL(BLUE, 2),
  141. ADJD_S311_CHANNEL(CLEAR, 3),
  142. IIO_CHAN_SOFT_TIMESTAMP(4),
  143. };
  144. static int adjd_s311_read_raw(struct iio_dev *indio_dev,
  145. struct iio_chan_spec const *chan,
  146. int *val, int *val2, long mask)
  147. {
  148. struct adjd_s311_data *data = iio_priv(indio_dev);
  149. int ret;
  150. switch (mask) {
  151. case IIO_CHAN_INFO_RAW:
  152. ret = adjd_s311_read_data(indio_dev, chan->address, val);
  153. if (ret < 0)
  154. return ret;
  155. return IIO_VAL_INT;
  156. case IIO_CHAN_INFO_HARDWAREGAIN:
  157. ret = i2c_smbus_read_byte_data(data->client,
  158. ADJD_S311_CAP_REG(chan->address));
  159. if (ret < 0)
  160. return ret;
  161. *val = ret & ADJD_S311_CAP_MASK;
  162. return IIO_VAL_INT;
  163. case IIO_CHAN_INFO_INT_TIME:
  164. ret = i2c_smbus_read_word_data(data->client,
  165. ADJD_S311_INT_REG(chan->address));
  166. if (ret < 0)
  167. return ret;
  168. *val = 0;
  169. /*
  170. * not documented, based on measurement:
  171. * 4095 LSBs correspond to roughly 4 ms
  172. */
  173. *val2 = ret & ADJD_S311_INT_MASK;
  174. return IIO_VAL_INT_PLUS_MICRO;
  175. }
  176. return -EINVAL;
  177. }
  178. static int adjd_s311_write_raw(struct iio_dev *indio_dev,
  179. struct iio_chan_spec const *chan,
  180. int val, int val2, long mask)
  181. {
  182. struct adjd_s311_data *data = iio_priv(indio_dev);
  183. switch (mask) {
  184. case IIO_CHAN_INFO_HARDWAREGAIN:
  185. if (val < 0 || val > ADJD_S311_CAP_MASK)
  186. return -EINVAL;
  187. return i2c_smbus_write_byte_data(data->client,
  188. ADJD_S311_CAP_REG(chan->address), val);
  189. case IIO_CHAN_INFO_INT_TIME:
  190. if (val != 0 || val2 < 0 || val2 > ADJD_S311_INT_MASK)
  191. return -EINVAL;
  192. return i2c_smbus_write_word_data(data->client,
  193. ADJD_S311_INT_REG(chan->address), val2);
  194. }
  195. return -EINVAL;
  196. }
  197. static int adjd_s311_update_scan_mode(struct iio_dev *indio_dev,
  198. const unsigned long *scan_mask)
  199. {
  200. struct adjd_s311_data *data = iio_priv(indio_dev);
  201. kfree(data->buffer);
  202. data->buffer = kmalloc(indio_dev->scan_bytes, GFP_KERNEL);
  203. if (data->buffer == NULL)
  204. return -ENOMEM;
  205. return 0;
  206. }
  207. static const struct iio_info adjd_s311_info = {
  208. .read_raw = adjd_s311_read_raw,
  209. .write_raw = adjd_s311_write_raw,
  210. .update_scan_mode = adjd_s311_update_scan_mode,
  211. .driver_module = THIS_MODULE,
  212. };
  213. static int adjd_s311_probe(struct i2c_client *client,
  214. const struct i2c_device_id *id)
  215. {
  216. struct adjd_s311_data *data;
  217. struct iio_dev *indio_dev;
  218. int err;
  219. indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
  220. if (indio_dev == NULL)
  221. return -ENOMEM;
  222. data = iio_priv(indio_dev);
  223. i2c_set_clientdata(client, indio_dev);
  224. data->client = client;
  225. indio_dev->dev.parent = &client->dev;
  226. indio_dev->info = &adjd_s311_info;
  227. indio_dev->name = ADJD_S311_DRV_NAME;
  228. indio_dev->channels = adjd_s311_channels;
  229. indio_dev->num_channels = ARRAY_SIZE(adjd_s311_channels);
  230. indio_dev->modes = INDIO_DIRECT_MODE;
  231. err = iio_triggered_buffer_setup(indio_dev, NULL,
  232. adjd_s311_trigger_handler, NULL);
  233. if (err < 0)
  234. return err;
  235. err = iio_device_register(indio_dev);
  236. if (err)
  237. goto exit_unreg_buffer;
  238. dev_info(&client->dev, "ADJD-S311 color sensor registered\n");
  239. return 0;
  240. exit_unreg_buffer:
  241. iio_triggered_buffer_cleanup(indio_dev);
  242. return err;
  243. }
  244. static int adjd_s311_remove(struct i2c_client *client)
  245. {
  246. struct iio_dev *indio_dev = i2c_get_clientdata(client);
  247. struct adjd_s311_data *data = iio_priv(indio_dev);
  248. iio_device_unregister(indio_dev);
  249. iio_triggered_buffer_cleanup(indio_dev);
  250. kfree(data->buffer);
  251. return 0;
  252. }
  253. static const struct i2c_device_id adjd_s311_id[] = {
  254. { "adjd_s311", 0 },
  255. { }
  256. };
  257. MODULE_DEVICE_TABLE(i2c, adjd_s311_id);
  258. static struct i2c_driver adjd_s311_driver = {
  259. .driver = {
  260. .name = ADJD_S311_DRV_NAME,
  261. },
  262. .probe = adjd_s311_probe,
  263. .remove = adjd_s311_remove,
  264. .id_table = adjd_s311_id,
  265. };
  266. module_i2c_driver(adjd_s311_driver);
  267. MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
  268. MODULE_DESCRIPTION("ADJD-S311 color sensor");
  269. MODULE_LICENSE("GPL");