162a1efb9SPeter Meerwald /* 2d978bfddSPeter Meerwald-Stadler * vcnl4000.c - Support for Vishay VCNL4000/4010/4020 combined ambient 3d978bfddSPeter Meerwald-Stadler * light and proximity sensor 462a1efb9SPeter Meerwald * 562a1efb9SPeter Meerwald * Copyright 2012 Peter Meerwald <pmeerw@pmeerw.net> 662a1efb9SPeter Meerwald * 762a1efb9SPeter Meerwald * This file is subject to the terms and conditions of version 2 of 862a1efb9SPeter Meerwald * the GNU General Public License. See the file COPYING in the main 962a1efb9SPeter Meerwald * directory of this archive for more details. 1062a1efb9SPeter Meerwald * 1162a1efb9SPeter Meerwald * IIO driver for VCNL4000 (7-bit I2C slave address 0x13) 1262a1efb9SPeter Meerwald * 1362a1efb9SPeter Meerwald * TODO: 1462a1efb9SPeter Meerwald * allow to adjust IR current 1562a1efb9SPeter Meerwald * proximity threshold and event handling 16d978bfddSPeter Meerwald-Stadler * periodic ALS/proximity measurement (VCNL4010/20) 17d978bfddSPeter Meerwald-Stadler * interrupts (VCNL4010/20) 1862a1efb9SPeter Meerwald */ 1962a1efb9SPeter Meerwald 2062a1efb9SPeter Meerwald #include <linux/module.h> 2162a1efb9SPeter Meerwald #include <linux/i2c.h> 2262a1efb9SPeter Meerwald #include <linux/err.h> 2362a1efb9SPeter Meerwald #include <linux/delay.h> 2462a1efb9SPeter Meerwald 2562a1efb9SPeter Meerwald #include <linux/iio/iio.h> 2662a1efb9SPeter Meerwald #include <linux/iio/sysfs.h> 2762a1efb9SPeter Meerwald 2862a1efb9SPeter Meerwald #define VCNL4000_DRV_NAME "vcnl4000" 291ebc787aSTomas Novotny #define VCNL4000_PROD_ID 0x01 301ebc787aSTomas Novotny #define VCNL4010_PROD_ID 0x02 /* for VCNL4020, VCNL4010 */ 3162a1efb9SPeter Meerwald 3262a1efb9SPeter Meerwald #define VCNL4000_COMMAND 0x80 /* Command register */ 3362a1efb9SPeter Meerwald #define VCNL4000_PROD_REV 0x81 /* Product ID and Revision ID */ 3462a1efb9SPeter Meerwald #define VCNL4000_LED_CURRENT 0x83 /* IR LED current for proximity mode */ 3562a1efb9SPeter Meerwald #define VCNL4000_AL_PARAM 0x84 /* Ambient light parameter register */ 3662a1efb9SPeter Meerwald #define VCNL4000_AL_RESULT_HI 0x85 /* Ambient light result register, MSB */ 3762a1efb9SPeter Meerwald #define VCNL4000_AL_RESULT_LO 0x86 /* Ambient light result register, LSB */ 3862a1efb9SPeter Meerwald #define VCNL4000_PS_RESULT_HI 0x87 /* Proximity result register, MSB */ 3962a1efb9SPeter Meerwald #define VCNL4000_PS_RESULT_LO 0x88 /* Proximity result register, LSB */ 4062a1efb9SPeter Meerwald #define VCNL4000_PS_MEAS_FREQ 0x89 /* Proximity test signal frequency */ 4162a1efb9SPeter Meerwald #define VCNL4000_PS_MOD_ADJ 0x8a /* Proximity modulator timing adjustment */ 4262a1efb9SPeter Meerwald 4362a1efb9SPeter Meerwald /* Bit masks for COMMAND register */ 44ff6a5259SPeter Meerwald-Stadler #define VCNL4000_AL_RDY BIT(6) /* ALS data ready? */ 45ff6a5259SPeter Meerwald-Stadler #define VCNL4000_PS_RDY BIT(5) /* proximity data ready? */ 46ff6a5259SPeter Meerwald-Stadler #define VCNL4000_AL_OD BIT(4) /* start on-demand ALS measurement */ 47ff6a5259SPeter Meerwald-Stadler #define VCNL4000_PS_OD BIT(3) /* start on-demand proximity measurement */ 4862a1efb9SPeter Meerwald 491ebc787aSTomas Novotny enum vcnl4000_device_ids { 501ebc787aSTomas Novotny VCNL4000, 51*50c50b97STomas Novotny VCNL4010, 521ebc787aSTomas Novotny }; 531ebc787aSTomas Novotny 5462a1efb9SPeter Meerwald struct vcnl4000_data { 5562a1efb9SPeter Meerwald struct i2c_client *client; 561ebc787aSTomas Novotny enum vcnl4000_device_ids id; 571ebc787aSTomas Novotny int rev; 581ebc787aSTomas Novotny int al_scale; 591ebc787aSTomas Novotny const struct vcnl4000_chip_spec *chip_spec; 60ff34ed6dSPeter Meerwald-Stadler struct mutex lock; 6162a1efb9SPeter Meerwald }; 6262a1efb9SPeter Meerwald 631ebc787aSTomas Novotny struct vcnl4000_chip_spec { 641ebc787aSTomas Novotny const char *prod; 651ebc787aSTomas Novotny int (*init)(struct vcnl4000_data *data); 661ebc787aSTomas Novotny int (*measure_light)(struct vcnl4000_data *data, int *val); 671ebc787aSTomas Novotny int (*measure_proximity)(struct vcnl4000_data *data, int *val); 681ebc787aSTomas Novotny }; 691ebc787aSTomas Novotny 7062a1efb9SPeter Meerwald static const struct i2c_device_id vcnl4000_id[] = { 711ebc787aSTomas Novotny { "vcnl4000", VCNL4000 }, 72*50c50b97STomas Novotny { "vcnl4010", VCNL4010 }, 73*50c50b97STomas Novotny { "vcnl4020", VCNL4010 }, 7462a1efb9SPeter Meerwald { } 7562a1efb9SPeter Meerwald }; 7662a1efb9SPeter Meerwald MODULE_DEVICE_TABLE(i2c, vcnl4000_id); 7762a1efb9SPeter Meerwald 781ebc787aSTomas Novotny static int vcnl4000_init(struct vcnl4000_data *data) 791ebc787aSTomas Novotny { 801ebc787aSTomas Novotny int ret, prod_id; 811ebc787aSTomas Novotny 821ebc787aSTomas Novotny ret = i2c_smbus_read_byte_data(data->client, VCNL4000_PROD_REV); 831ebc787aSTomas Novotny if (ret < 0) 841ebc787aSTomas Novotny return ret; 851ebc787aSTomas Novotny 861ebc787aSTomas Novotny prod_id = ret >> 4; 871ebc787aSTomas Novotny if (prod_id != VCNL4010_PROD_ID && prod_id != VCNL4000_PROD_ID) 881ebc787aSTomas Novotny return -ENODEV; 891ebc787aSTomas Novotny 901ebc787aSTomas Novotny data->rev = ret & 0xf; 911ebc787aSTomas Novotny data->al_scale = 250000; 921ebc787aSTomas Novotny 931ebc787aSTomas Novotny return 0; 941ebc787aSTomas Novotny }; 951ebc787aSTomas Novotny 9662a1efb9SPeter Meerwald static int vcnl4000_measure(struct vcnl4000_data *data, u8 req_mask, 9762a1efb9SPeter Meerwald u8 rdy_mask, u8 data_reg, int *val) 9862a1efb9SPeter Meerwald { 9962a1efb9SPeter Meerwald int tries = 20; 10091f197e0SLars-Peter Clausen __be16 buf; 10162a1efb9SPeter Meerwald int ret; 10262a1efb9SPeter Meerwald 103ff34ed6dSPeter Meerwald-Stadler mutex_lock(&data->lock); 104ff34ed6dSPeter Meerwald-Stadler 10562a1efb9SPeter Meerwald ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, 10662a1efb9SPeter Meerwald req_mask); 10762a1efb9SPeter Meerwald if (ret < 0) 108ff34ed6dSPeter Meerwald-Stadler goto fail; 10962a1efb9SPeter Meerwald 11062a1efb9SPeter Meerwald /* wait for data to become ready */ 11162a1efb9SPeter Meerwald while (tries--) { 11262a1efb9SPeter Meerwald ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND); 11362a1efb9SPeter Meerwald if (ret < 0) 114ff34ed6dSPeter Meerwald-Stadler goto fail; 11562a1efb9SPeter Meerwald if (ret & rdy_mask) 11662a1efb9SPeter Meerwald break; 11762a1efb9SPeter Meerwald msleep(20); /* measurement takes up to 100 ms */ 11862a1efb9SPeter Meerwald } 11962a1efb9SPeter Meerwald 12062a1efb9SPeter Meerwald if (tries < 0) { 12162a1efb9SPeter Meerwald dev_err(&data->client->dev, 12262a1efb9SPeter Meerwald "vcnl4000_measure() failed, data not ready\n"); 123ff34ed6dSPeter Meerwald-Stadler ret = -EIO; 124ff34ed6dSPeter Meerwald-Stadler goto fail; 12562a1efb9SPeter Meerwald } 12662a1efb9SPeter Meerwald 12762a1efb9SPeter Meerwald ret = i2c_smbus_read_i2c_block_data(data->client, 12862a1efb9SPeter Meerwald data_reg, sizeof(buf), (u8 *) &buf); 12962a1efb9SPeter Meerwald if (ret < 0) 130ff34ed6dSPeter Meerwald-Stadler goto fail; 13162a1efb9SPeter Meerwald 132ff34ed6dSPeter Meerwald-Stadler mutex_unlock(&data->lock); 13362a1efb9SPeter Meerwald *val = be16_to_cpu(buf); 13462a1efb9SPeter Meerwald 13562a1efb9SPeter Meerwald return 0; 136ff34ed6dSPeter Meerwald-Stadler 137ff34ed6dSPeter Meerwald-Stadler fail: 138ff34ed6dSPeter Meerwald-Stadler mutex_unlock(&data->lock); 139ff34ed6dSPeter Meerwald-Stadler return ret; 14062a1efb9SPeter Meerwald } 14162a1efb9SPeter Meerwald 1421ebc787aSTomas Novotny static int vcnl4000_measure_light(struct vcnl4000_data *data, int *val) 1431ebc787aSTomas Novotny { 1441ebc787aSTomas Novotny return vcnl4000_measure(data, 1451ebc787aSTomas Novotny VCNL4000_AL_OD, VCNL4000_AL_RDY, 1461ebc787aSTomas Novotny VCNL4000_AL_RESULT_HI, val); 1471ebc787aSTomas Novotny } 1481ebc787aSTomas Novotny 1491ebc787aSTomas Novotny static int vcnl4000_measure_proximity(struct vcnl4000_data *data, int *val) 1501ebc787aSTomas Novotny { 1511ebc787aSTomas Novotny return vcnl4000_measure(data, 1521ebc787aSTomas Novotny VCNL4000_PS_OD, VCNL4000_PS_RDY, 1531ebc787aSTomas Novotny VCNL4000_PS_RESULT_HI, val); 1541ebc787aSTomas Novotny } 1551ebc787aSTomas Novotny 1561ebc787aSTomas Novotny static const struct vcnl4000_chip_spec vcnl4000_chip_spec_cfg[] = { 1571ebc787aSTomas Novotny [VCNL4000] = { 1581ebc787aSTomas Novotny .prod = "VCNL4000", 1591ebc787aSTomas Novotny .init = vcnl4000_init, 1601ebc787aSTomas Novotny .measure_light = vcnl4000_measure_light, 1611ebc787aSTomas Novotny .measure_proximity = vcnl4000_measure_proximity, 1621ebc787aSTomas Novotny }, 163*50c50b97STomas Novotny [VCNL4010] = { 164*50c50b97STomas Novotny .prod = "VCNL4010/4020", 165*50c50b97STomas Novotny .init = vcnl4000_init, 166*50c50b97STomas Novotny .measure_light = vcnl4000_measure_light, 167*50c50b97STomas Novotny .measure_proximity = vcnl4000_measure_proximity, 168*50c50b97STomas Novotny }, 1691ebc787aSTomas Novotny }; 1701ebc787aSTomas Novotny 17162a1efb9SPeter Meerwald static const struct iio_chan_spec vcnl4000_channels[] = { 17262a1efb9SPeter Meerwald { 17362a1efb9SPeter Meerwald .type = IIO_LIGHT, 174bb7c5940SJonathan Cameron .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | 175bb7c5940SJonathan Cameron BIT(IIO_CHAN_INFO_SCALE), 17662a1efb9SPeter Meerwald }, { 17762a1efb9SPeter Meerwald .type = IIO_PROXIMITY, 178bb7c5940SJonathan Cameron .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 17962a1efb9SPeter Meerwald } 18062a1efb9SPeter Meerwald }; 18162a1efb9SPeter Meerwald 18262a1efb9SPeter Meerwald static int vcnl4000_read_raw(struct iio_dev *indio_dev, 18362a1efb9SPeter Meerwald struct iio_chan_spec const *chan, 18462a1efb9SPeter Meerwald int *val, int *val2, long mask) 18562a1efb9SPeter Meerwald { 1865d693139SPeter Meerwald-Stadler int ret; 18762a1efb9SPeter Meerwald struct vcnl4000_data *data = iio_priv(indio_dev); 18862a1efb9SPeter Meerwald 18962a1efb9SPeter Meerwald switch (mask) { 19062a1efb9SPeter Meerwald case IIO_CHAN_INFO_RAW: 19162a1efb9SPeter Meerwald switch (chan->type) { 19262a1efb9SPeter Meerwald case IIO_LIGHT: 1931ebc787aSTomas Novotny ret = data->chip_spec->measure_light(data, val); 19462a1efb9SPeter Meerwald if (ret < 0) 19562a1efb9SPeter Meerwald return ret; 1965d693139SPeter Meerwald-Stadler return IIO_VAL_INT; 19762a1efb9SPeter Meerwald case IIO_PROXIMITY: 1981ebc787aSTomas Novotny ret = data->chip_spec->measure_proximity(data, val); 19962a1efb9SPeter Meerwald if (ret < 0) 20062a1efb9SPeter Meerwald return ret; 2015d693139SPeter Meerwald-Stadler return IIO_VAL_INT; 20262a1efb9SPeter Meerwald default: 2035d693139SPeter Meerwald-Stadler return -EINVAL; 20462a1efb9SPeter Meerwald } 20562a1efb9SPeter Meerwald case IIO_CHAN_INFO_SCALE: 2065d693139SPeter Meerwald-Stadler if (chan->type != IIO_LIGHT) 2075d693139SPeter Meerwald-Stadler return -EINVAL; 2085d693139SPeter Meerwald-Stadler 20962a1efb9SPeter Meerwald *val = 0; 2101ebc787aSTomas Novotny *val2 = data->al_scale; 2115d693139SPeter Meerwald-Stadler return IIO_VAL_INT_PLUS_MICRO; 21262a1efb9SPeter Meerwald default: 2135d693139SPeter Meerwald-Stadler return -EINVAL; 21462a1efb9SPeter Meerwald } 21562a1efb9SPeter Meerwald } 21662a1efb9SPeter Meerwald 21762a1efb9SPeter Meerwald static const struct iio_info vcnl4000_info = { 21862a1efb9SPeter Meerwald .read_raw = vcnl4000_read_raw, 21962a1efb9SPeter Meerwald }; 22062a1efb9SPeter Meerwald 221fc52692cSGreg Kroah-Hartman static int vcnl4000_probe(struct i2c_client *client, 22262a1efb9SPeter Meerwald const struct i2c_device_id *id) 22362a1efb9SPeter Meerwald { 22462a1efb9SPeter Meerwald struct vcnl4000_data *data; 22562a1efb9SPeter Meerwald struct iio_dev *indio_dev; 2261ebc787aSTomas Novotny int ret; 22762a1efb9SPeter Meerwald 2282669d723SPeter Meerwald indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data)); 22962a1efb9SPeter Meerwald if (!indio_dev) 23062a1efb9SPeter Meerwald return -ENOMEM; 23162a1efb9SPeter Meerwald 23262a1efb9SPeter Meerwald data = iio_priv(indio_dev); 23362a1efb9SPeter Meerwald i2c_set_clientdata(client, indio_dev); 23462a1efb9SPeter Meerwald data->client = client; 2351ebc787aSTomas Novotny data->id = id->driver_data; 2361ebc787aSTomas Novotny data->chip_spec = &vcnl4000_chip_spec_cfg[data->id]; 237ff34ed6dSPeter Meerwald-Stadler mutex_init(&data->lock); 23862a1efb9SPeter Meerwald 2391ebc787aSTomas Novotny ret = data->chip_spec->init(data); 24062a1efb9SPeter Meerwald if (ret < 0) 2412669d723SPeter Meerwald return ret; 24262a1efb9SPeter Meerwald 243d978bfddSPeter Meerwald-Stadler dev_dbg(&client->dev, "%s Ambient light/proximity sensor, Rev: %02x\n", 2441ebc787aSTomas Novotny data->chip_spec->prod, data->rev); 24562a1efb9SPeter Meerwald 24662a1efb9SPeter Meerwald indio_dev->dev.parent = &client->dev; 24762a1efb9SPeter Meerwald indio_dev->info = &vcnl4000_info; 24862a1efb9SPeter Meerwald indio_dev->channels = vcnl4000_channels; 24962a1efb9SPeter Meerwald indio_dev->num_channels = ARRAY_SIZE(vcnl4000_channels); 25062a1efb9SPeter Meerwald indio_dev->name = VCNL4000_DRV_NAME; 25162a1efb9SPeter Meerwald indio_dev->modes = INDIO_DIRECT_MODE; 25262a1efb9SPeter Meerwald 253691dab42SSachin Kamat return devm_iio_device_register(&client->dev, indio_dev); 25462a1efb9SPeter Meerwald } 25562a1efb9SPeter Meerwald 25662a1efb9SPeter Meerwald static struct i2c_driver vcnl4000_driver = { 25762a1efb9SPeter Meerwald .driver = { 25862a1efb9SPeter Meerwald .name = VCNL4000_DRV_NAME, 25962a1efb9SPeter Meerwald }, 26062a1efb9SPeter Meerwald .probe = vcnl4000_probe, 26162a1efb9SPeter Meerwald .id_table = vcnl4000_id, 26262a1efb9SPeter Meerwald }; 26362a1efb9SPeter Meerwald 26462a1efb9SPeter Meerwald module_i2c_driver(vcnl4000_driver); 26562a1efb9SPeter Meerwald 26662a1efb9SPeter Meerwald MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>"); 26762a1efb9SPeter Meerwald MODULE_DESCRIPTION("Vishay VCNL4000 proximity/ambient light sensor driver"); 26862a1efb9SPeter Meerwald MODULE_LICENSE("GPL"); 269