vcnl4000.c 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. /*
  2. * vcnl4000.c - Support for Vishay VCNL4000/4010/4020 combined ambient
  3. * light and proximity sensor
  4. *
  5. * Copyright 2012 Peter Meerwald <pmeerw@pmeerw.net>
  6. *
  7. * This file is subject to the terms and conditions of version 2 of
  8. * the GNU General Public License. See the file COPYING in the main
  9. * directory of this archive for more details.
  10. *
  11. * IIO driver for VCNL4000 (7-bit I2C slave address 0x13)
  12. *
  13. * TODO:
  14. * allow to adjust IR current
  15. * proximity threshold and event handling
  16. * periodic ALS/proximity measurement (VCNL4010/20)
  17. * interrupts (VCNL4010/20)
  18. */
  19. #include <linux/module.h>
  20. #include <linux/i2c.h>
  21. #include <linux/err.h>
  22. #include <linux/delay.h>
  23. #include <linux/iio/iio.h>
  24. #include <linux/iio/sysfs.h>
  25. #define VCNL4000_DRV_NAME "vcnl4000"
  26. #define VCNL4000_ID 0x01
  27. #define VCNL4010_ID 0x02 /* for VCNL4020, VCNL4010 */
  28. #define VCNL4000_COMMAND 0x80 /* Command register */
  29. #define VCNL4000_PROD_REV 0x81 /* Product ID and Revision ID */
  30. #define VCNL4000_LED_CURRENT 0x83 /* IR LED current for proximity mode */
  31. #define VCNL4000_AL_PARAM 0x84 /* Ambient light parameter register */
  32. #define VCNL4000_AL_RESULT_HI 0x85 /* Ambient light result register, MSB */
  33. #define VCNL4000_AL_RESULT_LO 0x86 /* Ambient light result register, LSB */
  34. #define VCNL4000_PS_RESULT_HI 0x87 /* Proximity result register, MSB */
  35. #define VCNL4000_PS_RESULT_LO 0x88 /* Proximity result register, LSB */
  36. #define VCNL4000_PS_MEAS_FREQ 0x89 /* Proximity test signal frequency */
  37. #define VCNL4000_PS_MOD_ADJ 0x8a /* Proximity modulator timing adjustment */
  38. /* Bit masks for COMMAND register */
  39. #define VCNL4000_AL_RDY BIT(6) /* ALS data ready? */
  40. #define VCNL4000_PS_RDY BIT(5) /* proximity data ready? */
  41. #define VCNL4000_AL_OD BIT(4) /* start on-demand ALS measurement */
  42. #define VCNL4000_PS_OD BIT(3) /* start on-demand proximity measurement */
  43. struct vcnl4000_data {
  44. struct i2c_client *client;
  45. struct mutex lock;
  46. };
  47. static const struct i2c_device_id vcnl4000_id[] = {
  48. { "vcnl4000", 0 },
  49. { }
  50. };
  51. MODULE_DEVICE_TABLE(i2c, vcnl4000_id);
  52. static int vcnl4000_measure(struct vcnl4000_data *data, u8 req_mask,
  53. u8 rdy_mask, u8 data_reg, int *val)
  54. {
  55. int tries = 20;
  56. int ret;
  57. mutex_lock(&data->lock);
  58. ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND,
  59. req_mask);
  60. if (ret < 0)
  61. goto fail;
  62. /* wait for data to become ready */
  63. while (tries--) {
  64. ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND);
  65. if (ret < 0)
  66. goto fail;
  67. if (ret & rdy_mask)
  68. break;
  69. msleep(20); /* measurement takes up to 100 ms */
  70. }
  71. if (tries < 0) {
  72. dev_err(&data->client->dev,
  73. "vcnl4000_measure() failed, data not ready\n");
  74. ret = -EIO;
  75. goto fail;
  76. }
  77. ret = i2c_smbus_read_word_swapped(data->client, data_reg);
  78. if (ret < 0)
  79. goto fail;
  80. mutex_unlock(&data->lock);
  81. *val = ret;
  82. return 0;
  83. fail:
  84. mutex_unlock(&data->lock);
  85. return ret;
  86. }
  87. static const struct iio_chan_spec vcnl4000_channels[] = {
  88. {
  89. .type = IIO_LIGHT,
  90. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
  91. BIT(IIO_CHAN_INFO_SCALE),
  92. }, {
  93. .type = IIO_PROXIMITY,
  94. .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
  95. }
  96. };
  97. static int vcnl4000_read_raw(struct iio_dev *indio_dev,
  98. struct iio_chan_spec const *chan,
  99. int *val, int *val2, long mask)
  100. {
  101. int ret;
  102. struct vcnl4000_data *data = iio_priv(indio_dev);
  103. switch (mask) {
  104. case IIO_CHAN_INFO_RAW:
  105. switch (chan->type) {
  106. case IIO_LIGHT:
  107. ret = vcnl4000_measure(data,
  108. VCNL4000_AL_OD, VCNL4000_AL_RDY,
  109. VCNL4000_AL_RESULT_HI, val);
  110. if (ret < 0)
  111. return ret;
  112. return IIO_VAL_INT;
  113. case IIO_PROXIMITY:
  114. ret = vcnl4000_measure(data,
  115. VCNL4000_PS_OD, VCNL4000_PS_RDY,
  116. VCNL4000_PS_RESULT_HI, val);
  117. if (ret < 0)
  118. return ret;
  119. return IIO_VAL_INT;
  120. default:
  121. return -EINVAL;
  122. }
  123. case IIO_CHAN_INFO_SCALE:
  124. if (chan->type != IIO_LIGHT)
  125. return -EINVAL;
  126. *val = 0;
  127. *val2 = 250000;
  128. return IIO_VAL_INT_PLUS_MICRO;
  129. default:
  130. return -EINVAL;
  131. }
  132. }
  133. static const struct iio_info vcnl4000_info = {
  134. .read_raw = vcnl4000_read_raw,
  135. .driver_module = THIS_MODULE,
  136. };
  137. static int vcnl4000_probe(struct i2c_client *client,
  138. const struct i2c_device_id *id)
  139. {
  140. struct vcnl4000_data *data;
  141. struct iio_dev *indio_dev;
  142. int ret, prod_id;
  143. indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
  144. if (!indio_dev)
  145. return -ENOMEM;
  146. data = iio_priv(indio_dev);
  147. i2c_set_clientdata(client, indio_dev);
  148. data->client = client;
  149. mutex_init(&data->lock);
  150. ret = i2c_smbus_read_byte_data(data->client, VCNL4000_PROD_REV);
  151. if (ret < 0)
  152. return ret;
  153. prod_id = ret >> 4;
  154. if (prod_id != VCNL4010_ID && prod_id != VCNL4000_ID)
  155. return -ENODEV;
  156. dev_dbg(&client->dev, "%s Ambient light/proximity sensor, Rev: %02x\n",
  157. (prod_id == VCNL4010_ID) ? "VCNL4010/4020" : "VCNL4000",
  158. ret & 0xf);
  159. indio_dev->dev.parent = &client->dev;
  160. indio_dev->info = &vcnl4000_info;
  161. indio_dev->channels = vcnl4000_channels;
  162. indio_dev->num_channels = ARRAY_SIZE(vcnl4000_channels);
  163. indio_dev->name = VCNL4000_DRV_NAME;
  164. indio_dev->modes = INDIO_DIRECT_MODE;
  165. return devm_iio_device_register(&client->dev, indio_dev);
  166. }
  167. static struct i2c_driver vcnl4000_driver = {
  168. .driver = {
  169. .name = VCNL4000_DRV_NAME,
  170. },
  171. .probe = vcnl4000_probe,
  172. .id_table = vcnl4000_id,
  173. };
  174. module_i2c_driver(vcnl4000_driver);
  175. MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
  176. MODULE_DESCRIPTION("Vishay VCNL4000 proximity/ambient light sensor driver");
  177. MODULE_LICENSE("GPL");