2 * tcs3472.c - Support for TAOS TCS3472 color light-to-digital converter
4 * Copyright (c) 2013 Peter Meerwald <pmeerw@pmeerw.net>
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.
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,
14 * Datasheet: http://ams.com/eng/content/download/319364/1117183/file/TCS3472_Datasheet_EN_v2.pdf
16 * TODO: interrupt support, thresholds, wait time
19 #include <linux/module.h>
20 #include <linux/i2c.h>
21 #include <linux/delay.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>
30 #define TCS3472_DRV_NAME "tcs3472"
32 #define TCS3472_COMMAND BIT(7)
33 #define TCS3472_AUTO_INCR BIT(5)
35 #define TCS3472_ENABLE (TCS3472_COMMAND | 0x00)
36 #define TCS3472_ATIME (TCS3472_COMMAND | 0x01)
37 #define TCS3472_WTIME (TCS3472_COMMAND | 0x03)
38 #define TCS3472_AILT (TCS3472_COMMAND | 0x04)
39 #define TCS3472_AIHT (TCS3472_COMMAND | 0x06)
40 #define TCS3472_PERS (TCS3472_COMMAND | 0x0c)
41 #define TCS3472_CONFIG (TCS3472_COMMAND | 0x0d)
42 #define TCS3472_CONTROL (TCS3472_COMMAND | 0x0f)
43 #define TCS3472_ID (TCS3472_COMMAND | 0x12)
44 #define TCS3472_STATUS (TCS3472_COMMAND | 0x13)
45 #define TCS3472_CDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x14)
46 #define TCS3472_RDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x16)
47 #define TCS3472_GDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x18)
48 #define TCS3472_BDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x1a)
50 #define TCS3472_STATUS_AVALID BIT(0)
51 #define TCS3472_ENABLE_AEN BIT(1)
52 #define TCS3472_ENABLE_PON BIT(0)
53 #define TCS3472_CONTROL_AGAIN_MASK (BIT(0) | BIT(1))
56 struct i2c_client *client;
60 u16 buffer[8]; /* 4 16-bit channels + 64-bit timestamp */
63 #define TCS3472_CHANNEL(_color, _si, _addr) { \
64 .type = IIO_INTENSITY, \
66 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
67 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBSCALE) | \
68 BIT(IIO_CHAN_INFO_INT_TIME), \
69 .channel2 = IIO_MOD_LIGHT_##_color, \
76 .endianness = IIO_CPU, \
80 static const int tcs3472_agains[] = { 1, 4, 16, 60 };
82 static const struct iio_chan_spec tcs3472_channels[] = {
83 TCS3472_CHANNEL(CLEAR, 0, TCS3472_CDATA),
84 TCS3472_CHANNEL(RED, 1, TCS3472_RDATA),
85 TCS3472_CHANNEL(GREEN, 2, TCS3472_GDATA),
86 TCS3472_CHANNEL(BLUE, 3, TCS3472_BDATA),
87 IIO_CHAN_SOFT_TIMESTAMP(4),
90 static int tcs3472_req_data(struct tcs3472_data *data)
96 ret = i2c_smbus_read_byte_data(data->client, TCS3472_STATUS);
99 if (ret & TCS3472_STATUS_AVALID)
105 dev_err(&data->client->dev, "data not ready\n");
112 static int tcs3472_read_raw(struct iio_dev *indio_dev,
113 struct iio_chan_spec const *chan,
114 int *val, int *val2, long mask)
116 struct tcs3472_data *data = iio_priv(indio_dev);
120 case IIO_CHAN_INFO_RAW:
121 ret = iio_device_claim_direct_mode(indio_dev);
124 ret = tcs3472_req_data(data);
126 iio_device_release_direct_mode(indio_dev);
129 ret = i2c_smbus_read_word_data(data->client, chan->address);
130 iio_device_release_direct_mode(indio_dev);
135 case IIO_CHAN_INFO_CALIBSCALE:
136 *val = tcs3472_agains[data->control &
137 TCS3472_CONTROL_AGAIN_MASK];
139 case IIO_CHAN_INFO_INT_TIME:
141 *val2 = (256 - data->atime) * 2400;
142 return IIO_VAL_INT_PLUS_MICRO;
147 static int tcs3472_write_raw(struct iio_dev *indio_dev,
148 struct iio_chan_spec const *chan,
149 int val, int val2, long mask)
151 struct tcs3472_data *data = iio_priv(indio_dev);
155 case IIO_CHAN_INFO_CALIBSCALE:
158 for (i = 0; i < ARRAY_SIZE(tcs3472_agains); i++) {
159 if (val == tcs3472_agains[i]) {
160 data->control &= ~TCS3472_CONTROL_AGAIN_MASK;
162 return i2c_smbus_write_byte_data(
163 data->client, TCS3472_CONTROL,
168 case IIO_CHAN_INFO_INT_TIME:
171 for (i = 0; i < 256; i++) {
172 if (val2 == (256 - i) * 2400) {
174 return i2c_smbus_write_byte_data(
175 data->client, TCS3472_ATIME,
185 static irqreturn_t tcs3472_trigger_handler(int irq, void *p)
187 struct iio_poll_func *pf = p;
188 struct iio_dev *indio_dev = pf->indio_dev;
189 struct tcs3472_data *data = iio_priv(indio_dev);
192 int ret = tcs3472_req_data(data);
196 for_each_set_bit(i, indio_dev->active_scan_mask,
197 indio_dev->masklength) {
198 ret = i2c_smbus_read_word_data(data->client,
199 TCS3472_CDATA + 2*i);
203 data->buffer[j++] = ret;
206 iio_push_to_buffers_with_timestamp(indio_dev, data->buffer,
207 iio_get_time_ns(indio_dev));
210 iio_trigger_notify_done(indio_dev->trig);
215 static ssize_t tcs3472_show_int_time_available(struct device *dev,
216 struct device_attribute *attr,
222 for (i = 1; i <= 256; i++)
223 len += scnprintf(buf + len, PAGE_SIZE - len, "0.%06d ",
226 /* replace trailing space by newline */
232 static IIO_CONST_ATTR(calibscale_available, "1 4 16 60");
233 static IIO_DEV_ATTR_INT_TIME_AVAIL(tcs3472_show_int_time_available);
235 static struct attribute *tcs3472_attributes[] = {
236 &iio_const_attr_calibscale_available.dev_attr.attr,
237 &iio_dev_attr_integration_time_available.dev_attr.attr,
241 static const struct attribute_group tcs3472_attribute_group = {
242 .attrs = tcs3472_attributes,
245 static const struct iio_info tcs3472_info = {
246 .read_raw = tcs3472_read_raw,
247 .write_raw = tcs3472_write_raw,
248 .attrs = &tcs3472_attribute_group,
249 .driver_module = THIS_MODULE,
252 static int tcs3472_probe(struct i2c_client *client,
253 const struct i2c_device_id *id)
255 struct tcs3472_data *data;
256 struct iio_dev *indio_dev;
259 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
260 if (indio_dev == NULL)
263 data = iio_priv(indio_dev);
264 i2c_set_clientdata(client, indio_dev);
265 data->client = client;
267 indio_dev->dev.parent = &client->dev;
268 indio_dev->info = &tcs3472_info;
269 indio_dev->name = TCS3472_DRV_NAME;
270 indio_dev->channels = tcs3472_channels;
271 indio_dev->num_channels = ARRAY_SIZE(tcs3472_channels);
272 indio_dev->modes = INDIO_DIRECT_MODE;
274 ret = i2c_smbus_read_byte_data(data->client, TCS3472_ID);
279 dev_info(&client->dev, "TCS34721/34725 found\n");
280 else if (ret == 0x4d)
281 dev_info(&client->dev, "TCS34723/34727 found\n");
285 ret = i2c_smbus_read_byte_data(data->client, TCS3472_CONTROL);
290 ret = i2c_smbus_read_byte_data(data->client, TCS3472_ATIME);
295 ret = i2c_smbus_read_byte_data(data->client, TCS3472_ENABLE);
300 data->enable = ret | TCS3472_ENABLE_PON | TCS3472_ENABLE_AEN;
301 ret = i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE,
306 ret = iio_triggered_buffer_setup(indio_dev, NULL,
307 tcs3472_trigger_handler, NULL);
311 ret = iio_device_register(indio_dev);
318 iio_triggered_buffer_cleanup(indio_dev);
322 static int tcs3472_powerdown(struct tcs3472_data *data)
324 return i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE,
325 data->enable & ~(TCS3472_ENABLE_AEN | TCS3472_ENABLE_PON));
328 static int tcs3472_remove(struct i2c_client *client)
330 struct iio_dev *indio_dev = i2c_get_clientdata(client);
332 iio_device_unregister(indio_dev);
333 iio_triggered_buffer_cleanup(indio_dev);
334 tcs3472_powerdown(iio_priv(indio_dev));
339 #ifdef CONFIG_PM_SLEEP
340 static int tcs3472_suspend(struct device *dev)
342 struct tcs3472_data *data = iio_priv(i2c_get_clientdata(
343 to_i2c_client(dev)));
344 return tcs3472_powerdown(data);
347 static int tcs3472_resume(struct device *dev)
349 struct tcs3472_data *data = iio_priv(i2c_get_clientdata(
350 to_i2c_client(dev)));
351 return i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE,
352 data->enable | (TCS3472_ENABLE_AEN | TCS3472_ENABLE_PON));
356 static SIMPLE_DEV_PM_OPS(tcs3472_pm_ops, tcs3472_suspend, tcs3472_resume);
358 static const struct i2c_device_id tcs3472_id[] = {
362 MODULE_DEVICE_TABLE(i2c, tcs3472_id);
364 static struct i2c_driver tcs3472_driver = {
366 .name = TCS3472_DRV_NAME,
367 .pm = &tcs3472_pm_ops,
369 .probe = tcs3472_probe,
370 .remove = tcs3472_remove,
371 .id_table = tcs3472_id,
373 module_i2c_driver(tcs3472_driver);
375 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
376 MODULE_DESCRIPTION("TCS3472 color light sensors driver");
377 MODULE_LICENSE("GPL");