tcs3472.c 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. /*
  2. * tcs3472.c - Support for TAOS TCS3472 color light-to-digital converter
  3. *
  4. * Copyright (c) 2013 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. * Color light sensor with 16-bit channels for red, green, blue, clear);
  11. * 7-bit I2C slave address 0x39 (TCS34721, TCS34723) or 0x29 (TCS34725,
  12. * TCS34727)
  13. *
  14. * Datasheet: http://ams.com/eng/content/download/319364/1117183/file/TCS3472_Datasheet_EN_v2.pdf
  15. *
  16. * TODO: interrupt support, thresholds, wait time
  17. */
  18. #include <linux/module.h>
  19. #include <linux/i2c.h>
  20. #include <linux/delay.h>
  21. #include <linux/pm.h>
  22. #include <linux/iio/iio.h>
  23. #include <linux/iio/sysfs.h>
  24. #include <linux/iio/trigger_consumer.h>
  25. #include <linux/iio/buffer.h>
  26. #include <linux/iio/triggered_buffer.h>
  27. #define TCS3472_DRV_NAME "tcs3472"
  28. #define TCS3472_COMMAND BIT(7)
  29. #define TCS3472_AUTO_INCR BIT(5)
  30. #define TCS3472_ENABLE (TCS3472_COMMAND | 0x00)
  31. #define TCS3472_ATIME (TCS3472_COMMAND | 0x01)
  32. #define TCS3472_WTIME (TCS3472_COMMAND | 0x03)
  33. #define TCS3472_AILT (TCS3472_COMMAND | 0x04)
  34. #define TCS3472_AIHT (TCS3472_COMMAND | 0x06)
  35. #define TCS3472_PERS (TCS3472_COMMAND | 0x0c)
  36. #define TCS3472_CONFIG (TCS3472_COMMAND | 0x0d)
  37. #define TCS3472_CONTROL (TCS3472_COMMAND | 0x0f)
  38. #define TCS3472_ID (TCS3472_COMMAND | 0x12)
  39. #define TCS3472_STATUS (TCS3472_COMMAND | 0x13)
  40. #define TCS3472_CDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x14)
  41. #define TCS3472_RDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x16)
  42. #define TCS3472_GDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x18)
  43. #define TCS3472_BDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x1a)
  44. #define TCS3472_STATUS_AVALID BIT(0)
  45. #define TCS3472_ENABLE_AEN BIT(1)
  46. #define TCS3472_ENABLE_PON BIT(0)
  47. #define TCS3472_CONTROL_AGAIN_MASK (BIT(0) | BIT(1))
  48. struct tcs3472_data {
  49. struct i2c_client *client;
  50. u8 enable;
  51. u8 control;
  52. u8 atime;
  53. u16 buffer[8]; /* 4 16-bit channels + 64-bit timestamp */
  54. };
  55. #define TCS3472_CHANNEL(_color, _si, _addr) { \
  56. .type = IIO_INTENSITY, \
  57. .modified = 1, \
  58. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
  59. .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBSCALE) | \
  60. BIT(IIO_CHAN_INFO_INT_TIME), \
  61. .channel2 = IIO_MOD_LIGHT_##_color, \
  62. .address = _addr, \
  63. .scan_index = _si, \
  64. .scan_type = { \
  65. .sign = 'u', \
  66. .realbits = 16, \
  67. .storagebits = 16, \
  68. .endianness = IIO_CPU, \
  69. }, \
  70. }
  71. static const int tcs3472_agains[] = { 1, 4, 16, 60 };
  72. static const struct iio_chan_spec tcs3472_channels[] = {
  73. TCS3472_CHANNEL(CLEAR, 0, TCS3472_CDATA),
  74. TCS3472_CHANNEL(RED, 1, TCS3472_RDATA),
  75. TCS3472_CHANNEL(GREEN, 2, TCS3472_GDATA),
  76. TCS3472_CHANNEL(BLUE, 3, TCS3472_BDATA),
  77. IIO_CHAN_SOFT_TIMESTAMP(4),
  78. };
  79. static int tcs3472_req_data(struct tcs3472_data *data)
  80. {
  81. int tries = 50;
  82. int ret;
  83. while (tries--) {
  84. ret = i2c_smbus_read_byte_data(data->client, TCS3472_STATUS);
  85. if (ret < 0)
  86. return ret;
  87. if (ret & TCS3472_STATUS_AVALID)
  88. break;
  89. msleep(20);
  90. }
  91. if (tries < 0) {
  92. dev_err(&data->client->dev, "data not ready\n");
  93. return -EIO;
  94. }
  95. return 0;
  96. }
  97. static int tcs3472_read_raw(struct iio_dev *indio_dev,
  98. struct iio_chan_spec const *chan,
  99. int *val, int *val2, long mask)
  100. {
  101. struct tcs3472_data *data = iio_priv(indio_dev);
  102. int ret;
  103. switch (mask) {
  104. case IIO_CHAN_INFO_RAW:
  105. ret = iio_device_claim_direct_mode(indio_dev);
  106. if (ret)
  107. return ret;
  108. ret = tcs3472_req_data(data);
  109. if (ret < 0) {
  110. iio_device_release_direct_mode(indio_dev);
  111. return ret;
  112. }
  113. ret = i2c_smbus_read_word_data(data->client, chan->address);
  114. iio_device_release_direct_mode(indio_dev);
  115. if (ret < 0)
  116. return ret;
  117. *val = ret;
  118. return IIO_VAL_INT;
  119. case IIO_CHAN_INFO_CALIBSCALE:
  120. *val = tcs3472_agains[data->control &
  121. TCS3472_CONTROL_AGAIN_MASK];
  122. return IIO_VAL_INT;
  123. case IIO_CHAN_INFO_INT_TIME:
  124. *val = 0;
  125. *val2 = (256 - data->atime) * 2400;
  126. return IIO_VAL_INT_PLUS_MICRO;
  127. }
  128. return -EINVAL;
  129. }
  130. static int tcs3472_write_raw(struct iio_dev *indio_dev,
  131. struct iio_chan_spec const *chan,
  132. int val, int val2, long mask)
  133. {
  134. struct tcs3472_data *data = iio_priv(indio_dev);
  135. int i;
  136. switch (mask) {
  137. case IIO_CHAN_INFO_CALIBSCALE:
  138. if (val2 != 0)
  139. return -EINVAL;
  140. for (i = 0; i < ARRAY_SIZE(tcs3472_agains); i++) {
  141. if (val == tcs3472_agains[i]) {
  142. data->control &= ~TCS3472_CONTROL_AGAIN_MASK;
  143. data->control |= i;
  144. return i2c_smbus_write_byte_data(
  145. data->client, TCS3472_CONTROL,
  146. data->control);
  147. }
  148. }
  149. return -EINVAL;
  150. case IIO_CHAN_INFO_INT_TIME:
  151. if (val != 0)
  152. return -EINVAL;
  153. for (i = 0; i < 256; i++) {
  154. if (val2 == (256 - i) * 2400) {
  155. data->atime = i;
  156. return i2c_smbus_write_byte_data(
  157. data->client, TCS3472_ATIME,
  158. data->atime);
  159. }
  160. }
  161. return -EINVAL;
  162. }
  163. return -EINVAL;
  164. }
  165. static irqreturn_t tcs3472_trigger_handler(int irq, void *p)
  166. {
  167. struct iio_poll_func *pf = p;
  168. struct iio_dev *indio_dev = pf->indio_dev;
  169. struct tcs3472_data *data = iio_priv(indio_dev);
  170. int i, j = 0;
  171. int ret = tcs3472_req_data(data);
  172. if (ret < 0)
  173. goto done;
  174. for_each_set_bit(i, indio_dev->active_scan_mask,
  175. indio_dev->masklength) {
  176. ret = i2c_smbus_read_word_data(data->client,
  177. TCS3472_CDATA + 2*i);
  178. if (ret < 0)
  179. goto done;
  180. data->buffer[j++] = ret;
  181. }
  182. iio_push_to_buffers_with_timestamp(indio_dev, data->buffer,
  183. iio_get_time_ns(indio_dev));
  184. done:
  185. iio_trigger_notify_done(indio_dev->trig);
  186. return IRQ_HANDLED;
  187. }
  188. static ssize_t tcs3472_show_int_time_available(struct device *dev,
  189. struct device_attribute *attr,
  190. char *buf)
  191. {
  192. size_t len = 0;
  193. int i;
  194. for (i = 1; i <= 256; i++)
  195. len += scnprintf(buf + len, PAGE_SIZE - len, "0.%06d ",
  196. 2400 * i);
  197. /* replace trailing space by newline */
  198. buf[len - 1] = '\n';
  199. return len;
  200. }
  201. static IIO_CONST_ATTR(calibscale_available, "1 4 16 60");
  202. static IIO_DEV_ATTR_INT_TIME_AVAIL(tcs3472_show_int_time_available);
  203. static struct attribute *tcs3472_attributes[] = {
  204. &iio_const_attr_calibscale_available.dev_attr.attr,
  205. &iio_dev_attr_integration_time_available.dev_attr.attr,
  206. NULL
  207. };
  208. static const struct attribute_group tcs3472_attribute_group = {
  209. .attrs = tcs3472_attributes,
  210. };
  211. static const struct iio_info tcs3472_info = {
  212. .read_raw = tcs3472_read_raw,
  213. .write_raw = tcs3472_write_raw,
  214. .attrs = &tcs3472_attribute_group,
  215. .driver_module = THIS_MODULE,
  216. };
  217. static int tcs3472_probe(struct i2c_client *client,
  218. const struct i2c_device_id *id)
  219. {
  220. struct tcs3472_data *data;
  221. struct iio_dev *indio_dev;
  222. int ret;
  223. indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
  224. if (indio_dev == NULL)
  225. return -ENOMEM;
  226. data = iio_priv(indio_dev);
  227. i2c_set_clientdata(client, indio_dev);
  228. data->client = client;
  229. indio_dev->dev.parent = &client->dev;
  230. indio_dev->info = &tcs3472_info;
  231. indio_dev->name = TCS3472_DRV_NAME;
  232. indio_dev->channels = tcs3472_channels;
  233. indio_dev->num_channels = ARRAY_SIZE(tcs3472_channels);
  234. indio_dev->modes = INDIO_DIRECT_MODE;
  235. ret = i2c_smbus_read_byte_data(data->client, TCS3472_ID);
  236. if (ret < 0)
  237. return ret;
  238. if (ret == 0x44)
  239. dev_info(&client->dev, "TCS34721/34725 found\n");
  240. else if (ret == 0x4d)
  241. dev_info(&client->dev, "TCS34723/34727 found\n");
  242. else
  243. return -ENODEV;
  244. ret = i2c_smbus_read_byte_data(data->client, TCS3472_CONTROL);
  245. if (ret < 0)
  246. return ret;
  247. data->control = ret;
  248. ret = i2c_smbus_read_byte_data(data->client, TCS3472_ATIME);
  249. if (ret < 0)
  250. return ret;
  251. data->atime = ret;
  252. ret = i2c_smbus_read_byte_data(data->client, TCS3472_ENABLE);
  253. if (ret < 0)
  254. return ret;
  255. /* enable device */
  256. data->enable = ret | TCS3472_ENABLE_PON | TCS3472_ENABLE_AEN;
  257. ret = i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE,
  258. data->enable);
  259. if (ret < 0)
  260. return ret;
  261. ret = iio_triggered_buffer_setup(indio_dev, NULL,
  262. tcs3472_trigger_handler, NULL);
  263. if (ret < 0)
  264. return ret;
  265. ret = iio_device_register(indio_dev);
  266. if (ret < 0)
  267. goto buffer_cleanup;
  268. return 0;
  269. buffer_cleanup:
  270. iio_triggered_buffer_cleanup(indio_dev);
  271. return ret;
  272. }
  273. static int tcs3472_powerdown(struct tcs3472_data *data)
  274. {
  275. return i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE,
  276. data->enable & ~(TCS3472_ENABLE_AEN | TCS3472_ENABLE_PON));
  277. }
  278. static int tcs3472_remove(struct i2c_client *client)
  279. {
  280. struct iio_dev *indio_dev = i2c_get_clientdata(client);
  281. iio_device_unregister(indio_dev);
  282. iio_triggered_buffer_cleanup(indio_dev);
  283. tcs3472_powerdown(iio_priv(indio_dev));
  284. return 0;
  285. }
  286. #ifdef CONFIG_PM_SLEEP
  287. static int tcs3472_suspend(struct device *dev)
  288. {
  289. struct tcs3472_data *data = iio_priv(i2c_get_clientdata(
  290. to_i2c_client(dev)));
  291. return tcs3472_powerdown(data);
  292. }
  293. static int tcs3472_resume(struct device *dev)
  294. {
  295. struct tcs3472_data *data = iio_priv(i2c_get_clientdata(
  296. to_i2c_client(dev)));
  297. return i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE,
  298. data->enable | (TCS3472_ENABLE_AEN | TCS3472_ENABLE_PON));
  299. }
  300. #endif
  301. static SIMPLE_DEV_PM_OPS(tcs3472_pm_ops, tcs3472_suspend, tcs3472_resume);
  302. static const struct i2c_device_id tcs3472_id[] = {
  303. { "tcs3472", 0 },
  304. { }
  305. };
  306. MODULE_DEVICE_TABLE(i2c, tcs3472_id);
  307. static struct i2c_driver tcs3472_driver = {
  308. .driver = {
  309. .name = TCS3472_DRV_NAME,
  310. .pm = &tcs3472_pm_ops,
  311. },
  312. .probe = tcs3472_probe,
  313. .remove = tcs3472_remove,
  314. .id_table = tcs3472_id,
  315. };
  316. module_i2c_driver(tcs3472_driver);
  317. MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
  318. MODULE_DESCRIPTION("TCS3472 color light sensors driver");
  319. MODULE_LICENSE("GPL");