Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

iio: Add tcs3472 color light sensor driver

chip has four 16-bit channels for red, green, blue, clear color
intensity; driver supports the TCS3x7x family of devices and was
tested with a TCS34725 chip; further information here:
http://www.ams.com/eng/Products/Light-Sensors/Color-Sensor/TCS34725

v2 (thanks to Jonathan Cameron):
* drop dynamic buffer allocation, buffer is in tcs3472_data
* limit sysfs output to PAGE_SIZE
* check val2 == 0 when writing CALIBSCALE

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Cc: Jon Brenner <jon.brenner@ams.com>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>

authored by

Peter Meerwald and committed by
Jonathan Cameron
eb869ade ea01f2c1

+380
+10
drivers/iio/light/Kconfig
··· 55 55 changes. The ALS-control output values can be set per zone for the 56 56 three current output channels. 57 57 58 + config TCS3472 59 + tristate "TAOS TCS3472 color light-to-digital converter" 60 + depends on I2C 61 + help 62 + If you say yes here you get support for the TAOS TCS3472 63 + family of color light-to-digital converters with IR filter. 64 + 65 + This driver can also be built as a module. If so, the module 66 + will be called tcs3472. 67 + 58 68 config SENSORS_TSL2563 59 69 tristate "TAOS TSL2560, TSL2561, TSL2562 and TSL2563 ambient light sensors" 60 70 depends on I2C
+1
drivers/iio/light/Makefile
··· 8 8 obj-$(CONFIG_HID_SENSOR_ALS) += hid-sensor-als.o 9 9 obj-$(CONFIG_SENSORS_LM3533) += lm3533-als.o 10 10 obj-$(CONFIG_SENSORS_TSL2563) += tsl2563.o 11 + obj-$(CONFIG_TCS3472) += tcs3472.o 11 12 obj-$(CONFIG_TSL4531) += tsl4531.o 12 13 obj-$(CONFIG_VCNL4000) += vcnl4000.o
+369
drivers/iio/light/tcs3472.c
··· 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 + * TODO: interrupt support, thresholds, wait time 15 + */ 16 + 17 + #include <linux/module.h> 18 + #include <linux/i2c.h> 19 + #include <linux/delay.h> 20 + #include <linux/pm.h> 21 + 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 + 28 + #define TCS3472_DRV_NAME "tcs3472" 29 + 30 + #define TCS3472_COMMAND BIT(7) 31 + #define TCS3472_AUTO_INCR BIT(5) 32 + 33 + #define TCS3472_ENABLE (TCS3472_COMMAND | 0x00) 34 + #define TCS3472_ATIME (TCS3472_COMMAND | 0x01) 35 + #define TCS3472_WTIME (TCS3472_COMMAND | 0x03) 36 + #define TCS3472_AILT (TCS3472_COMMAND | 0x04) 37 + #define TCS3472_AIHT (TCS3472_COMMAND | 0x06) 38 + #define TCS3472_PERS (TCS3472_COMMAND | 0x0c) 39 + #define TCS3472_CONFIG (TCS3472_COMMAND | 0x0d) 40 + #define TCS3472_CONTROL (TCS3472_COMMAND | 0x0f) 41 + #define TCS3472_ID (TCS3472_COMMAND | 0x12) 42 + #define TCS3472_STATUS (TCS3472_COMMAND | 0x13) 43 + #define TCS3472_CDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x14) 44 + #define TCS3472_RDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x16) 45 + #define TCS3472_GDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x18) 46 + #define TCS3472_BDATA (TCS3472_COMMAND | TCS3472_AUTO_INCR | 0x1a) 47 + 48 + #define TCS3472_STATUS_AVALID BIT(0) 49 + #define TCS3472_ENABLE_AEN BIT(1) 50 + #define TCS3472_ENABLE_PON BIT(0) 51 + #define TCS3472_CONTROL_AGAIN_MASK (BIT(0) | BIT(1)) 52 + 53 + struct tcs3472_data { 54 + struct i2c_client *client; 55 + u8 enable; 56 + u8 control; 57 + u8 atime; 58 + u16 buffer[4]; 59 + }; 60 + 61 + /* 4 16-bit channels + timestamp = 16 bytes */ 62 + #define TSL3472_BUFFER_SIZE 16 63 + 64 + #define TCS3472_CHANNEL(_color, _si, _addr) { \ 65 + .type = IIO_INTENSITY, \ 66 + .modified = 1, \ 67 + .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ 68 + .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_CALIBSCALE) | \ 69 + BIT(IIO_CHAN_INFO_INT_TIME), \ 70 + .channel2 = IIO_MOD_LIGHT_##_color, \ 71 + .address = _addr, \ 72 + .scan_index = _si, \ 73 + .scan_type = IIO_ST('u', 16, 16, 0), \ 74 + } 75 + 76 + static const int tcs3472_agains[] = { 1, 4, 16, 60 }; 77 + 78 + static const struct iio_chan_spec tcs3472_channels[] = { 79 + TCS3472_CHANNEL(CLEAR, 0, TCS3472_CDATA), 80 + TCS3472_CHANNEL(RED, 1, TCS3472_RDATA), 81 + TCS3472_CHANNEL(GREEN, 2, TCS3472_GDATA), 82 + TCS3472_CHANNEL(BLUE, 3, TCS3472_BDATA), 83 + IIO_CHAN_SOFT_TIMESTAMP(4), 84 + }; 85 + 86 + static int tcs3472_req_data(struct tcs3472_data *data) 87 + { 88 + int tries = 50; 89 + int ret; 90 + 91 + while (tries--) { 92 + ret = i2c_smbus_read_byte_data(data->client, TCS3472_STATUS); 93 + if (ret < 0) 94 + return ret; 95 + if (ret & TCS3472_STATUS_AVALID) 96 + break; 97 + msleep(20); 98 + } 99 + 100 + if (tries < 0) { 101 + dev_err(&data->client->dev, "data not ready\n"); 102 + return -EIO; 103 + } 104 + 105 + return 0; 106 + } 107 + 108 + static int tcs3472_read_raw(struct iio_dev *indio_dev, 109 + struct iio_chan_spec const *chan, 110 + int *val, int *val2, long mask) 111 + { 112 + struct tcs3472_data *data = iio_priv(indio_dev); 113 + int ret; 114 + 115 + switch (mask) { 116 + case IIO_CHAN_INFO_RAW: 117 + ret = tcs3472_req_data(data); 118 + if (ret < 0) 119 + return ret; 120 + ret = i2c_smbus_read_word_data(data->client, chan->address); 121 + if (ret < 0) 122 + return ret; 123 + *val = ret; 124 + return IIO_VAL_INT; 125 + case IIO_CHAN_INFO_CALIBSCALE: 126 + *val = tcs3472_agains[data->control & 127 + TCS3472_CONTROL_AGAIN_MASK]; 128 + return IIO_VAL_INT; 129 + case IIO_CHAN_INFO_INT_TIME: 130 + *val = 0; 131 + *val2 = (256 - data->atime) * 2400; 132 + return IIO_VAL_INT_PLUS_MICRO; 133 + } 134 + return -EINVAL; 135 + } 136 + 137 + static int tcs3472_write_raw(struct iio_dev *indio_dev, 138 + struct iio_chan_spec const *chan, 139 + int val, int val2, long mask) 140 + { 141 + struct tcs3472_data *data = iio_priv(indio_dev); 142 + int i; 143 + 144 + switch (mask) { 145 + case IIO_CHAN_INFO_CALIBSCALE: 146 + if (val2 != 0) 147 + return -EINVAL; 148 + for (i = 0; i < ARRAY_SIZE(tcs3472_agains); i++) { 149 + if (val == tcs3472_agains[i]) { 150 + data->control &= ~TCS3472_CONTROL_AGAIN_MASK; 151 + data->control |= i; 152 + return i2c_smbus_write_byte_data( 153 + data->client, TCS3472_CONTROL, 154 + data->control); 155 + } 156 + } 157 + return -EINVAL; 158 + case IIO_CHAN_INFO_INT_TIME: 159 + if (val != 0) 160 + return -EINVAL; 161 + for (i = 0; i < 256; i++) { 162 + if (val2 == (256 - i) * 2400) { 163 + data->atime = i; 164 + return i2c_smbus_write_word_data( 165 + data->client, TCS3472_ATIME, 166 + data->atime); 167 + } 168 + 169 + } 170 + return -EINVAL; 171 + } 172 + return -EINVAL; 173 + } 174 + 175 + static irqreturn_t tcs3472_trigger_handler(int irq, void *p) 176 + { 177 + struct iio_poll_func *pf = p; 178 + struct iio_dev *indio_dev = pf->indio_dev; 179 + struct tcs3472_data *data = iio_priv(indio_dev); 180 + int len = 0; 181 + int i, j = 0; 182 + 183 + int ret = tcs3472_req_data(data); 184 + if (ret < 0) 185 + goto done; 186 + 187 + for_each_set_bit(i, indio_dev->active_scan_mask, 188 + indio_dev->masklength) { 189 + ret = i2c_smbus_read_word_data(data->client, 190 + TCS3472_CDATA + 2*i); 191 + if (ret < 0) 192 + goto done; 193 + 194 + data->buffer[j++] = ret; 195 + len += 2; 196 + } 197 + 198 + if (indio_dev->scan_timestamp) 199 + *(s64 *)((u8 *)data->buffer + ALIGN(len, sizeof(s64))) 200 + = iio_get_time_ns(); 201 + iio_push_to_buffers(indio_dev, (u8 *)data->buffer); 202 + 203 + done: 204 + iio_trigger_notify_done(indio_dev->trig); 205 + 206 + return IRQ_HANDLED; 207 + } 208 + 209 + static ssize_t tcs3472_show_int_time_available(struct device *dev, 210 + struct device_attribute *attr, 211 + char *buf) 212 + { 213 + size_t len = 0; 214 + int i; 215 + 216 + for (i = 1; i <= 256; i++) 217 + len += scnprintf(buf + len, PAGE_SIZE - len, "0.%06d ", 218 + 2400 * i); 219 + 220 + /* replace trailing space by newline */ 221 + buf[len - 1] = '\n'; 222 + 223 + return len; 224 + } 225 + 226 + static IIO_CONST_ATTR(calibscale_available, "1 4 16 60"); 227 + static IIO_DEV_ATTR_INT_TIME_AVAIL(tcs3472_show_int_time_available); 228 + 229 + static struct attribute *tcs3472_attributes[] = { 230 + &iio_const_attr_calibscale_available.dev_attr.attr, 231 + &iio_dev_attr_integration_time_available.dev_attr.attr, 232 + NULL 233 + }; 234 + 235 + static const struct attribute_group tcs3472_attribute_group = { 236 + .attrs = tcs3472_attributes, 237 + }; 238 + 239 + static const struct iio_info tcs3472_info = { 240 + .read_raw = tcs3472_read_raw, 241 + .write_raw = tcs3472_write_raw, 242 + .attrs = &tcs3472_attribute_group, 243 + .driver_module = THIS_MODULE, 244 + }; 245 + 246 + static int tcs3472_probe(struct i2c_client *client, 247 + const struct i2c_device_id *id) 248 + { 249 + struct tcs3472_data *data; 250 + struct iio_dev *indio_dev; 251 + int ret; 252 + 253 + indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data)); 254 + if (indio_dev == NULL) 255 + return -ENOMEM; 256 + 257 + data = iio_priv(indio_dev); 258 + i2c_set_clientdata(client, indio_dev); 259 + data->client = client; 260 + 261 + indio_dev->dev.parent = &client->dev; 262 + indio_dev->info = &tcs3472_info; 263 + indio_dev->name = TCS3472_DRV_NAME; 264 + indio_dev->channels = tcs3472_channels; 265 + indio_dev->num_channels = ARRAY_SIZE(tcs3472_channels); 266 + indio_dev->modes = INDIO_DIRECT_MODE; 267 + 268 + ret = i2c_smbus_read_byte_data(data->client, TCS3472_ID); 269 + if (ret < 0) 270 + return ret; 271 + 272 + if (ret == 0x44) 273 + dev_info(&client->dev, "TCS34721/34725 found\n"); 274 + else if (ret == 0x4d) 275 + dev_info(&client->dev, "TCS34723/34727 found\n"); 276 + else 277 + return -ENODEV; 278 + 279 + ret = i2c_smbus_read_byte_data(data->client, TCS3472_CONTROL); 280 + if (ret < 0) 281 + return ret; 282 + data->control = ret; 283 + 284 + ret = i2c_smbus_read_byte_data(data->client, TCS3472_ATIME); 285 + if (ret < 0) 286 + return ret; 287 + data->atime = ret; 288 + 289 + ret = i2c_smbus_read_byte_data(data->client, TCS3472_ENABLE); 290 + if (ret < 0) 291 + return ret; 292 + 293 + /* enable device */ 294 + data->enable = ret | TCS3472_ENABLE_PON | TCS3472_ENABLE_AEN; 295 + ret = i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE, 296 + data->enable); 297 + if (ret < 0) 298 + return ret; 299 + 300 + ret = iio_triggered_buffer_setup(indio_dev, NULL, 301 + tcs3472_trigger_handler, NULL); 302 + if (ret < 0) 303 + return ret; 304 + 305 + ret = iio_device_register(indio_dev); 306 + if (ret < 0) 307 + goto buffer_cleanup; 308 + 309 + return 0; 310 + 311 + buffer_cleanup: 312 + iio_triggered_buffer_cleanup(indio_dev); 313 + return ret; 314 + } 315 + 316 + static int tcs3472_powerdown(struct tcs3472_data *data) 317 + { 318 + return i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE, 319 + data->enable & ~(TCS3472_ENABLE_AEN | TCS3472_ENABLE_PON)); 320 + } 321 + 322 + static int tcs3472_remove(struct i2c_client *client) 323 + { 324 + struct iio_dev *indio_dev = i2c_get_clientdata(client); 325 + 326 + iio_device_unregister(indio_dev); 327 + iio_triggered_buffer_cleanup(indio_dev); 328 + tcs3472_powerdown(iio_priv(indio_dev)); 329 + 330 + return 0; 331 + } 332 + 333 + #ifdef CONFIG_PM_SLEEP 334 + static int tcs3472_suspend(struct device *dev) 335 + { 336 + return tcs3472_powerdown(iio_priv(dev_to_iio_dev(dev))); 337 + } 338 + 339 + static int tcs3472_resume(struct device *dev) 340 + { 341 + struct tcs3472_data *data = iio_priv(dev_to_iio_dev(dev)); 342 + return i2c_smbus_write_byte_data(data->client, TCS3472_ENABLE, 343 + data->enable | (TCS3472_ENABLE_AEN | TCS3472_ENABLE_PON)); 344 + } 345 + #endif 346 + 347 + static SIMPLE_DEV_PM_OPS(tcs3472_pm_ops, tcs3472_suspend, tcs3472_resume); 348 + 349 + static const struct i2c_device_id tcs3472_id[] = { 350 + { "tcs3472", 0 }, 351 + { } 352 + }; 353 + MODULE_DEVICE_TABLE(i2c, tcs3472_id); 354 + 355 + static struct i2c_driver tcs3472_driver = { 356 + .driver = { 357 + .name = TCS3472_DRV_NAME, 358 + .pm = &tcs3472_pm_ops, 359 + .owner = THIS_MODULE, 360 + }, 361 + .probe = tcs3472_probe, 362 + .remove = tcs3472_remove, 363 + .id_table = tcs3472_id, 364 + }; 365 + module_i2c_driver(tcs3472_driver); 366 + 367 + MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>"); 368 + MODULE_DESCRIPTION("TCS3472 color light sensors driver"); 369 + MODULE_LICENSE("GPL");