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, 5150c50b97STomas 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 }, 7250c50b97STomas Novotny { "vcnl4010", VCNL4010 }, 7350c50b97STomas 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; 87*58bf9aceSTomas Novotny switch (prod_id) { 88*58bf9aceSTomas Novotny case VCNL4000_PROD_ID: 89*58bf9aceSTomas Novotny if (data->id != VCNL4000) 90*58bf9aceSTomas Novotny dev_warn(&data->client->dev, 91*58bf9aceSTomas Novotny "wrong device id, use vcnl4000"); 92*58bf9aceSTomas Novotny break; 93*58bf9aceSTomas Novotny case VCNL4010_PROD_ID: 94*58bf9aceSTomas Novotny if (data->id != VCNL4010) 95*58bf9aceSTomas Novotny dev_warn(&data->client->dev, 96*58bf9aceSTomas Novotny "wrong device id, use vcnl4010/4020"); 97*58bf9aceSTomas Novotny break; 98*58bf9aceSTomas Novotny default: 991ebc787aSTomas Novotny return -ENODEV; 100*58bf9aceSTomas Novotny } 1011ebc787aSTomas Novotny 1021ebc787aSTomas Novotny data->rev = ret & 0xf; 1031ebc787aSTomas Novotny data->al_scale = 250000; 1041ebc787aSTomas Novotny 1051ebc787aSTomas Novotny return 0; 1061ebc787aSTomas Novotny }; 1071ebc787aSTomas Novotny 10862a1efb9SPeter Meerwald static int vcnl4000_measure(struct vcnl4000_data *data, u8 req_mask, 10962a1efb9SPeter Meerwald u8 rdy_mask, u8 data_reg, int *val) 11062a1efb9SPeter Meerwald { 11162a1efb9SPeter Meerwald int tries = 20; 11291f197e0SLars-Peter Clausen __be16 buf; 11362a1efb9SPeter Meerwald int ret; 11462a1efb9SPeter Meerwald 115ff34ed6dSPeter Meerwald-Stadler mutex_lock(&data->lock); 116ff34ed6dSPeter Meerwald-Stadler 11762a1efb9SPeter Meerwald ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, 11862a1efb9SPeter Meerwald req_mask); 11962a1efb9SPeter Meerwald if (ret < 0) 120ff34ed6dSPeter Meerwald-Stadler goto fail; 12162a1efb9SPeter Meerwald 12262a1efb9SPeter Meerwald /* wait for data to become ready */ 12362a1efb9SPeter Meerwald while (tries--) { 12462a1efb9SPeter Meerwald ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND); 12562a1efb9SPeter Meerwald if (ret < 0) 126ff34ed6dSPeter Meerwald-Stadler goto fail; 12762a1efb9SPeter Meerwald if (ret & rdy_mask) 12862a1efb9SPeter Meerwald break; 12962a1efb9SPeter Meerwald msleep(20); /* measurement takes up to 100 ms */ 13062a1efb9SPeter Meerwald } 13162a1efb9SPeter Meerwald 13262a1efb9SPeter Meerwald if (tries < 0) { 13362a1efb9SPeter Meerwald dev_err(&data->client->dev, 13462a1efb9SPeter Meerwald "vcnl4000_measure() failed, data not ready\n"); 135ff34ed6dSPeter Meerwald-Stadler ret = -EIO; 136ff34ed6dSPeter Meerwald-Stadler goto fail; 13762a1efb9SPeter Meerwald } 13862a1efb9SPeter Meerwald 13962a1efb9SPeter Meerwald ret = i2c_smbus_read_i2c_block_data(data->client, 14062a1efb9SPeter Meerwald data_reg, sizeof(buf), (u8 *) &buf); 14162a1efb9SPeter Meerwald if (ret < 0) 142ff34ed6dSPeter Meerwald-Stadler goto fail; 14362a1efb9SPeter Meerwald 144ff34ed6dSPeter Meerwald-Stadler mutex_unlock(&data->lock); 14562a1efb9SPeter Meerwald *val = be16_to_cpu(buf); 14662a1efb9SPeter Meerwald 14762a1efb9SPeter Meerwald return 0; 148ff34ed6dSPeter Meerwald-Stadler 149ff34ed6dSPeter Meerwald-Stadler fail: 150ff34ed6dSPeter Meerwald-Stadler mutex_unlock(&data->lock); 151ff34ed6dSPeter Meerwald-Stadler return ret; 15262a1efb9SPeter Meerwald } 15362a1efb9SPeter Meerwald 1541ebc787aSTomas Novotny static int vcnl4000_measure_light(struct vcnl4000_data *data, int *val) 1551ebc787aSTomas Novotny { 1561ebc787aSTomas Novotny return vcnl4000_measure(data, 1571ebc787aSTomas Novotny VCNL4000_AL_OD, VCNL4000_AL_RDY, 1581ebc787aSTomas Novotny VCNL4000_AL_RESULT_HI, val); 1591ebc787aSTomas Novotny } 1601ebc787aSTomas Novotny 1611ebc787aSTomas Novotny static int vcnl4000_measure_proximity(struct vcnl4000_data *data, int *val) 1621ebc787aSTomas Novotny { 1631ebc787aSTomas Novotny return vcnl4000_measure(data, 1641ebc787aSTomas Novotny VCNL4000_PS_OD, VCNL4000_PS_RDY, 1651ebc787aSTomas Novotny VCNL4000_PS_RESULT_HI, val); 1661ebc787aSTomas Novotny } 1671ebc787aSTomas Novotny 1681ebc787aSTomas Novotny static const struct vcnl4000_chip_spec vcnl4000_chip_spec_cfg[] = { 1691ebc787aSTomas Novotny [VCNL4000] = { 1701ebc787aSTomas Novotny .prod = "VCNL4000", 1711ebc787aSTomas Novotny .init = vcnl4000_init, 1721ebc787aSTomas Novotny .measure_light = vcnl4000_measure_light, 1731ebc787aSTomas Novotny .measure_proximity = vcnl4000_measure_proximity, 1741ebc787aSTomas Novotny }, 17550c50b97STomas Novotny [VCNL4010] = { 17650c50b97STomas Novotny .prod = "VCNL4010/4020", 17750c50b97STomas Novotny .init = vcnl4000_init, 17850c50b97STomas Novotny .measure_light = vcnl4000_measure_light, 17950c50b97STomas Novotny .measure_proximity = vcnl4000_measure_proximity, 18050c50b97STomas Novotny }, 1811ebc787aSTomas Novotny }; 1821ebc787aSTomas Novotny 18362a1efb9SPeter Meerwald static const struct iio_chan_spec vcnl4000_channels[] = { 18462a1efb9SPeter Meerwald { 18562a1efb9SPeter Meerwald .type = IIO_LIGHT, 186bb7c5940SJonathan Cameron .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | 187bb7c5940SJonathan Cameron BIT(IIO_CHAN_INFO_SCALE), 18862a1efb9SPeter Meerwald }, { 18962a1efb9SPeter Meerwald .type = IIO_PROXIMITY, 190bb7c5940SJonathan Cameron .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), 19162a1efb9SPeter Meerwald } 19262a1efb9SPeter Meerwald }; 19362a1efb9SPeter Meerwald 19462a1efb9SPeter Meerwald static int vcnl4000_read_raw(struct iio_dev *indio_dev, 19562a1efb9SPeter Meerwald struct iio_chan_spec const *chan, 19662a1efb9SPeter Meerwald int *val, int *val2, long mask) 19762a1efb9SPeter Meerwald { 1985d693139SPeter Meerwald-Stadler int ret; 19962a1efb9SPeter Meerwald struct vcnl4000_data *data = iio_priv(indio_dev); 20062a1efb9SPeter Meerwald 20162a1efb9SPeter Meerwald switch (mask) { 20262a1efb9SPeter Meerwald case IIO_CHAN_INFO_RAW: 20362a1efb9SPeter Meerwald switch (chan->type) { 20462a1efb9SPeter Meerwald case IIO_LIGHT: 2051ebc787aSTomas Novotny ret = data->chip_spec->measure_light(data, val); 20662a1efb9SPeter Meerwald if (ret < 0) 20762a1efb9SPeter Meerwald return ret; 2085d693139SPeter Meerwald-Stadler return IIO_VAL_INT; 20962a1efb9SPeter Meerwald case IIO_PROXIMITY: 2101ebc787aSTomas Novotny ret = data->chip_spec->measure_proximity(data, val); 21162a1efb9SPeter Meerwald if (ret < 0) 21262a1efb9SPeter Meerwald return ret; 2135d693139SPeter Meerwald-Stadler return IIO_VAL_INT; 21462a1efb9SPeter Meerwald default: 2155d693139SPeter Meerwald-Stadler return -EINVAL; 21662a1efb9SPeter Meerwald } 21762a1efb9SPeter Meerwald case IIO_CHAN_INFO_SCALE: 2185d693139SPeter Meerwald-Stadler if (chan->type != IIO_LIGHT) 2195d693139SPeter Meerwald-Stadler return -EINVAL; 2205d693139SPeter Meerwald-Stadler 22162a1efb9SPeter Meerwald *val = 0; 2221ebc787aSTomas Novotny *val2 = data->al_scale; 2235d693139SPeter Meerwald-Stadler return IIO_VAL_INT_PLUS_MICRO; 22462a1efb9SPeter Meerwald default: 2255d693139SPeter Meerwald-Stadler return -EINVAL; 22662a1efb9SPeter Meerwald } 22762a1efb9SPeter Meerwald } 22862a1efb9SPeter Meerwald 22962a1efb9SPeter Meerwald static const struct iio_info vcnl4000_info = { 23062a1efb9SPeter Meerwald .read_raw = vcnl4000_read_raw, 23162a1efb9SPeter Meerwald }; 23262a1efb9SPeter Meerwald 233fc52692cSGreg Kroah-Hartman static int vcnl4000_probe(struct i2c_client *client, 23462a1efb9SPeter Meerwald const struct i2c_device_id *id) 23562a1efb9SPeter Meerwald { 23662a1efb9SPeter Meerwald struct vcnl4000_data *data; 23762a1efb9SPeter Meerwald struct iio_dev *indio_dev; 2381ebc787aSTomas Novotny int ret; 23962a1efb9SPeter Meerwald 2402669d723SPeter Meerwald indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data)); 24162a1efb9SPeter Meerwald if (!indio_dev) 24262a1efb9SPeter Meerwald return -ENOMEM; 24362a1efb9SPeter Meerwald 24462a1efb9SPeter Meerwald data = iio_priv(indio_dev); 24562a1efb9SPeter Meerwald i2c_set_clientdata(client, indio_dev); 24662a1efb9SPeter Meerwald data->client = client; 2471ebc787aSTomas Novotny data->id = id->driver_data; 2481ebc787aSTomas Novotny data->chip_spec = &vcnl4000_chip_spec_cfg[data->id]; 249ff34ed6dSPeter Meerwald-Stadler mutex_init(&data->lock); 25062a1efb9SPeter Meerwald 2511ebc787aSTomas Novotny ret = data->chip_spec->init(data); 25262a1efb9SPeter Meerwald if (ret < 0) 2532669d723SPeter Meerwald return ret; 25462a1efb9SPeter Meerwald 255d978bfddSPeter Meerwald-Stadler dev_dbg(&client->dev, "%s Ambient light/proximity sensor, Rev: %02x\n", 2561ebc787aSTomas Novotny data->chip_spec->prod, data->rev); 25762a1efb9SPeter Meerwald 25862a1efb9SPeter Meerwald indio_dev->dev.parent = &client->dev; 25962a1efb9SPeter Meerwald indio_dev->info = &vcnl4000_info; 26062a1efb9SPeter Meerwald indio_dev->channels = vcnl4000_channels; 26162a1efb9SPeter Meerwald indio_dev->num_channels = ARRAY_SIZE(vcnl4000_channels); 26262a1efb9SPeter Meerwald indio_dev->name = VCNL4000_DRV_NAME; 26362a1efb9SPeter Meerwald indio_dev->modes = INDIO_DIRECT_MODE; 26462a1efb9SPeter Meerwald 265691dab42SSachin Kamat return devm_iio_device_register(&client->dev, indio_dev); 26662a1efb9SPeter Meerwald } 26762a1efb9SPeter Meerwald 26862a1efb9SPeter Meerwald static struct i2c_driver vcnl4000_driver = { 26962a1efb9SPeter Meerwald .driver = { 27062a1efb9SPeter Meerwald .name = VCNL4000_DRV_NAME, 27162a1efb9SPeter Meerwald }, 27262a1efb9SPeter Meerwald .probe = vcnl4000_probe, 27362a1efb9SPeter Meerwald .id_table = vcnl4000_id, 27462a1efb9SPeter Meerwald }; 27562a1efb9SPeter Meerwald 27662a1efb9SPeter Meerwald module_i2c_driver(vcnl4000_driver); 27762a1efb9SPeter Meerwald 27862a1efb9SPeter Meerwald MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>"); 27962a1efb9SPeter Meerwald MODULE_DESCRIPTION("Vishay VCNL4000 proximity/ambient light sensor driver"); 28062a1efb9SPeter Meerwald MODULE_LICENSE("GPL"); 281