1 // SPDX-License-Identifier: GPL-2.0-only
3 * vcnl4000.c - Support for Vishay VCNL4000/4010/4020/4040/4200 combined ambient
4 * light and proximity sensor
7 * Copyright 2019 Pursim SPC
11 * VCNL4000/10/20 (7-bit I2C slave address 0x13)
12 * VCNL4040 (7-bit I2C slave address 0x60)
13 * VCNL4200 (7-bit I2C slave address 0x51)
16 * allow to adjust IR current
17 * interrupts (VCNL4040, VCNL4200)
20 #include <linux/bitfield.h>
21 #include <linux/module.h>
22 #include <linux/i2c.h>
23 #include <linux/err.h>
24 #include <linux/delay.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/interrupt.h>
28 #include <linux/iio/buffer.h>
29 #include <linux/iio/events.h>
30 #include <linux/iio/iio.h>
31 #include <linux/iio/sysfs.h>
32 #include <linux/iio/trigger.h>
33 #include <linux/iio/trigger_consumer.h>
34 #include <linux/iio/triggered_buffer.h>
36 #define VCNL4000_DRV_NAME "vcnl4000"
37 #define VCNL4000_PROD_ID 0x01
38 #define VCNL4010_PROD_ID 0x02 /* for VCNL4020, VCNL4010 */
39 #define VCNL4040_PROD_ID 0x86
40 #define VCNL4200_PROD_ID 0x58
42 #define VCNL4000_COMMAND 0x80 /* Command register */
43 #define VCNL4000_PROD_REV 0x81 /* Product ID and Revision ID */
44 #define VCNL4010_PROX_RATE 0x82 /* Proximity rate */
45 #define VCNL4000_LED_CURRENT 0x83 /* IR LED current for proximity mode */
46 #define VCNL4000_AL_PARAM 0x84 /* Ambient light parameter register */
47 #define VCNL4010_ALS_PARAM 0x84 /* ALS rate */
48 #define VCNL4000_AL_RESULT_HI 0x85 /* Ambient light result register, MSB */
49 #define VCNL4000_AL_RESULT_LO 0x86 /* Ambient light result register, LSB */
50 #define VCNL4000_PS_RESULT_HI 0x87 /* Proximity result register, MSB */
51 #define VCNL4000_PS_RESULT_LO 0x88 /* Proximity result register, LSB */
52 #define VCNL4000_PS_MEAS_FREQ 0x89 /* Proximity test signal frequency */
53 #define VCNL4010_INT_CTRL 0x89 /* Interrupt control */
54 #define VCNL4000_PS_MOD_ADJ 0x8a /* Proximity modulator timing adjustment */
55 #define VCNL4010_LOW_THR_HI 0x8a /* Low threshold, MSB */
56 #define VCNL4010_LOW_THR_LO 0x8b /* Low threshold, LSB */
57 #define VCNL4010_HIGH_THR_HI 0x8c /* High threshold, MSB */
58 #define VCNL4010_HIGH_THR_LO 0x8d /* High threshold, LSB */
59 #define VCNL4010_ISR 0x8e /* Interrupt status */
61 #define VCNL4200_AL_CONF 0x00 /* Ambient light configuration */
62 #define VCNL4200_PS_CONF1 0x03 /* Proximity configuration */
63 #define VCNL4200_PS_DATA 0x08 /* Proximity data */
64 #define VCNL4200_AL_DATA 0x09 /* Ambient light data */
65 #define VCNL4200_DEV_ID 0x0e /* Device ID, slave address and version */
67 #define VCNL4040_DEV_ID 0x0c /* Device ID and version */
69 /* Bit masks for COMMAND register */
70 #define VCNL4000_AL_RDY BIT(6) /* ALS data ready? */
71 #define VCNL4000_PS_RDY BIT(5) /* proximity data ready? */
72 #define VCNL4000_AL_OD BIT(4) /* start on-demand ALS measurement */
73 #define VCNL4000_PS_OD BIT(3) /* start on-demand proximity measurement */
74 #define VCNL4000_ALS_EN BIT(2) /* start ALS measurement */
75 #define VCNL4000_PROX_EN BIT(1) /* start proximity measurement */
76 #define VCNL4000_SELF_TIMED_EN BIT(0) /* start self-timed measurement */
78 #define VCNL4040_ALS_CONF_ALS_SHUTDOWN BIT(0)
79 #define VCNL4040_PS_CONF1_PS_SHUTDOWN BIT(0)
80 #define VCNL4040_PS_CONF2_PS_IT GENMASK(3, 1) /* Proximity integration time */
82 /* Bit masks for interrupt registers. */
83 #define VCNL4010_INT_THR_SEL BIT(0) /* Select threshold interrupt source */
84 #define VCNL4010_INT_THR_EN BIT(1) /* Threshold interrupt type */
85 #define VCNL4010_INT_ALS_EN BIT(2) /* Enable on ALS data ready */
86 #define VCNL4010_INT_PROX_EN BIT(3) /* Enable on proximity data ready */
88 #define VCNL4010_INT_THR_HIGH 0 /* High threshold exceeded */
89 #define VCNL4010_INT_THR_LOW 1 /* Low threshold exceeded */
90 #define VCNL4010_INT_ALS 2 /* ALS data ready */
91 #define VCNL4010_INT_PROXIMITY 3 /* Proximity data ready */
93 #define VCNL4010_INT_THR \
94 (BIT(VCNL4010_INT_THR_LOW) | BIT(VCNL4010_INT_THR_HIGH))
95 #define VCNL4010_INT_DRDY \
96 (BIT(VCNL4010_INT_PROXIMITY) | BIT(VCNL4010_INT_ALS))
98 static const int vcnl4010_prox_sampling_frequency[][2] = {
109 static const int vcnl4040_ps_it_times[][2] = {
120 #define VCNL4000_SLEEP_DELAY_MS 2000 /* before we enter pm_runtime_suspend */
122 enum vcnl4000_device_ids {
129 struct vcnl4200_channel {
131 ktime_t last_measurement;
132 ktime_t sampling_rate;
136 struct vcnl4000_data {
137 struct i2c_client *client;
138 enum vcnl4000_device_ids id;
141 const struct vcnl4000_chip_spec *chip_spec;
142 struct mutex vcnl4000_lock;
143 struct vcnl4200_channel vcnl4200_al;
144 struct vcnl4200_channel vcnl4200_ps;
148 struct vcnl4000_chip_spec {
150 struct iio_chan_spec const *channels;
151 const int num_channels;
152 const struct iio_info *info;
154 int (*init)(struct vcnl4000_data *data);
155 int (*measure_light)(struct vcnl4000_data *data, int *val);
156 int (*measure_proximity)(struct vcnl4000_data *data, int *val);
157 int (*set_power_state)(struct vcnl4000_data *data, bool on);
160 static const struct i2c_device_id vcnl4000_id[] = {
161 { "vcnl4000", VCNL4000 },
162 { "vcnl4010", VCNL4010 },
163 { "vcnl4020", VCNL4010 },
164 { "vcnl4040", VCNL4040 },
165 { "vcnl4200", VCNL4200 },
168 MODULE_DEVICE_TABLE(i2c, vcnl4000_id);
170 static int vcnl4000_set_power_state(struct vcnl4000_data *data, bool on)
176 static int vcnl4000_init(struct vcnl4000_data *data)
180 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_PROD_REV);
186 case VCNL4000_PROD_ID:
187 if (data->id != VCNL4000)
188 dev_warn(&data->client->dev,
189 "wrong device id, use vcnl4000");
191 case VCNL4010_PROD_ID:
192 if (data->id != VCNL4010)
193 dev_warn(&data->client->dev,
194 "wrong device id, use vcnl4010/4020");
200 data->rev = ret & 0xf;
201 data->al_scale = 250000;
202 mutex_init(&data->vcnl4000_lock);
204 return data->chip_spec->set_power_state(data, true);
207 static ssize_t vcnl4000_write_als_enable(struct vcnl4000_data *data, bool en)
211 mutex_lock(&data->vcnl4000_lock);
213 ret = i2c_smbus_read_word_data(data->client, VCNL4200_AL_CONF);
218 ret &= ~VCNL4040_ALS_CONF_ALS_SHUTDOWN;
220 ret |= VCNL4040_ALS_CONF_ALS_SHUTDOWN;
222 ret = i2c_smbus_write_word_data(data->client, VCNL4200_AL_CONF, ret);
225 mutex_unlock(&data->vcnl4000_lock);
230 static ssize_t vcnl4000_write_ps_enable(struct vcnl4000_data *data, bool en)
234 mutex_lock(&data->vcnl4000_lock);
236 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
241 ret &= ~VCNL4040_PS_CONF1_PS_SHUTDOWN;
243 ret |= VCNL4040_PS_CONF1_PS_SHUTDOWN;
245 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1, ret);
248 mutex_unlock(&data->vcnl4000_lock);
253 static int vcnl4200_set_power_state(struct vcnl4000_data *data, bool on)
257 ret = vcnl4000_write_als_enable(data, on);
261 ret = vcnl4000_write_ps_enable(data, on);
266 /* Wait at least one integration cycle before fetching data */
267 data->vcnl4200_al.last_measurement = ktime_get();
268 data->vcnl4200_ps.last_measurement = ktime_get();
274 static int vcnl4200_init(struct vcnl4000_data *data)
278 ret = i2c_smbus_read_word_data(data->client, VCNL4200_DEV_ID);
284 if (id != VCNL4200_PROD_ID) {
285 ret = i2c_smbus_read_word_data(data->client, VCNL4040_DEV_ID);
291 if (id != VCNL4040_PROD_ID)
295 dev_dbg(&data->client->dev, "device id 0x%x", id);
297 data->rev = (ret >> 8) & 0xf;
299 data->vcnl4200_al.reg = VCNL4200_AL_DATA;
300 data->vcnl4200_ps.reg = VCNL4200_PS_DATA;
302 case VCNL4200_PROD_ID:
303 /* Default wait time is 50ms, add 20% tolerance. */
304 data->vcnl4200_al.sampling_rate = ktime_set(0, 60000 * 1000);
305 /* Default wait time is 4.8ms, add 20% tolerance. */
306 data->vcnl4200_ps.sampling_rate = ktime_set(0, 5760 * 1000);
307 data->al_scale = 24000;
309 case VCNL4040_PROD_ID:
310 /* Default wait time is 80ms, add 20% tolerance. */
311 data->vcnl4200_al.sampling_rate = ktime_set(0, 96000 * 1000);
312 /* Default wait time is 5ms, add 20% tolerance. */
313 data->vcnl4200_ps.sampling_rate = ktime_set(0, 6000 * 1000);
314 data->al_scale = 120000;
317 mutex_init(&data->vcnl4200_al.lock);
318 mutex_init(&data->vcnl4200_ps.lock);
320 ret = data->chip_spec->set_power_state(data, true);
327 static int vcnl4000_read_data(struct vcnl4000_data *data, u8 data_reg, int *val)
331 ret = i2c_smbus_read_word_swapped(data->client, data_reg);
339 static int vcnl4000_write_data(struct vcnl4000_data *data, u8 data_reg, int val)
344 return i2c_smbus_write_word_swapped(data->client, data_reg, val);
348 static int vcnl4000_measure(struct vcnl4000_data *data, u8 req_mask,
349 u8 rdy_mask, u8 data_reg, int *val)
354 mutex_lock(&data->vcnl4000_lock);
356 ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND,
361 /* wait for data to become ready */
363 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND);
368 msleep(20); /* measurement takes up to 100 ms */
372 dev_err(&data->client->dev,
373 "vcnl4000_measure() failed, data not ready\n");
378 ret = vcnl4000_read_data(data, data_reg, val);
382 mutex_unlock(&data->vcnl4000_lock);
387 mutex_unlock(&data->vcnl4000_lock);
391 static int vcnl4200_measure(struct vcnl4000_data *data,
392 struct vcnl4200_channel *chan, int *val)
396 ktime_t next_measurement;
398 mutex_lock(&chan->lock);
400 next_measurement = ktime_add(chan->last_measurement,
401 chan->sampling_rate);
402 delta = ktime_us_delta(next_measurement, ktime_get());
404 usleep_range(delta, delta + 500);
405 chan->last_measurement = ktime_get();
407 mutex_unlock(&chan->lock);
409 ret = i2c_smbus_read_word_data(data->client, chan->reg);
418 static int vcnl4000_measure_light(struct vcnl4000_data *data, int *val)
420 return vcnl4000_measure(data,
421 VCNL4000_AL_OD, VCNL4000_AL_RDY,
422 VCNL4000_AL_RESULT_HI, val);
425 static int vcnl4200_measure_light(struct vcnl4000_data *data, int *val)
427 return vcnl4200_measure(data, &data->vcnl4200_al, val);
430 static int vcnl4000_measure_proximity(struct vcnl4000_data *data, int *val)
432 return vcnl4000_measure(data,
433 VCNL4000_PS_OD, VCNL4000_PS_RDY,
434 VCNL4000_PS_RESULT_HI, val);
437 static int vcnl4200_measure_proximity(struct vcnl4000_data *data, int *val)
439 return vcnl4200_measure(data, &data->vcnl4200_ps, val);
442 static int vcnl4010_read_proxy_samp_freq(struct vcnl4000_data *data, int *val,
447 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_PROX_RATE);
451 if (ret >= ARRAY_SIZE(vcnl4010_prox_sampling_frequency))
454 *val = vcnl4010_prox_sampling_frequency[ret][0];
455 *val2 = vcnl4010_prox_sampling_frequency[ret][1];
460 static bool vcnl4010_is_in_periodic_mode(struct vcnl4000_data *data)
464 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND);
468 return !!(ret & VCNL4000_SELF_TIMED_EN);
471 static int vcnl4000_set_pm_runtime_state(struct vcnl4000_data *data, bool on)
473 struct device *dev = &data->client->dev;
477 ret = pm_runtime_resume_and_get(dev);
479 pm_runtime_mark_last_busy(dev);
480 ret = pm_runtime_put_autosuspend(dev);
486 static int vcnl4040_read_ps_it(struct vcnl4000_data *data, int *val, int *val2)
490 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
494 ret = FIELD_GET(VCNL4040_PS_CONF2_PS_IT, ret);
496 if (ret >= ARRAY_SIZE(vcnl4040_ps_it_times))
499 *val = vcnl4040_ps_it_times[ret][0];
500 *val2 = vcnl4040_ps_it_times[ret][1];
505 static ssize_t vcnl4040_write_ps_it(struct vcnl4000_data *data, int val)
511 for (i = 0; i < ARRAY_SIZE(vcnl4040_ps_it_times); i++) {
512 if (val == vcnl4040_ps_it_times[i][1]) {
521 mutex_lock(&data->vcnl4000_lock);
523 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
527 regval = (ret & ~VCNL4040_PS_CONF2_PS_IT) |
528 FIELD_PREP(VCNL4040_PS_CONF2_PS_IT, index);
529 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1,
533 mutex_unlock(&data->vcnl4000_lock);
537 static int vcnl4000_read_raw(struct iio_dev *indio_dev,
538 struct iio_chan_spec const *chan,
539 int *val, int *val2, long mask)
542 struct vcnl4000_data *data = iio_priv(indio_dev);
545 case IIO_CHAN_INFO_RAW:
546 ret = vcnl4000_set_pm_runtime_state(data, true);
550 switch (chan->type) {
552 ret = data->chip_spec->measure_light(data, val);
557 ret = data->chip_spec->measure_proximity(data, val);
564 vcnl4000_set_pm_runtime_state(data, false);
566 case IIO_CHAN_INFO_SCALE:
567 if (chan->type != IIO_LIGHT)
571 *val2 = data->al_scale;
572 return IIO_VAL_INT_PLUS_MICRO;
573 case IIO_CHAN_INFO_INT_TIME:
574 if (chan->type != IIO_PROXIMITY)
576 ret = vcnl4040_read_ps_it(data, val, val2);
579 return IIO_VAL_INT_PLUS_MICRO;
585 static int vcnl4040_write_raw(struct iio_dev *indio_dev,
586 struct iio_chan_spec const *chan,
587 int val, int val2, long mask)
589 struct vcnl4000_data *data = iio_priv(indio_dev);
592 case IIO_CHAN_INFO_INT_TIME:
595 if (chan->type != IIO_PROXIMITY)
597 return vcnl4040_write_ps_it(data, val2);
603 static int vcnl4040_read_avail(struct iio_dev *indio_dev,
604 struct iio_chan_spec const *chan,
605 const int **vals, int *type, int *length,
609 case IIO_CHAN_INFO_INT_TIME:
610 *vals = (int *)vcnl4040_ps_it_times;
611 *type = IIO_VAL_INT_PLUS_MICRO;
612 *length = 2 * ARRAY_SIZE(vcnl4040_ps_it_times);
613 return IIO_AVAIL_LIST;
619 static int vcnl4010_read_raw(struct iio_dev *indio_dev,
620 struct iio_chan_spec const *chan,
621 int *val, int *val2, long mask)
624 struct vcnl4000_data *data = iio_priv(indio_dev);
627 case IIO_CHAN_INFO_RAW:
628 case IIO_CHAN_INFO_SCALE:
629 ret = iio_device_claim_direct_mode(indio_dev);
633 /* Protect against event capture. */
634 if (vcnl4010_is_in_periodic_mode(data)) {
637 ret = vcnl4000_read_raw(indio_dev, chan, val, val2,
641 iio_device_release_direct_mode(indio_dev);
643 case IIO_CHAN_INFO_SAMP_FREQ:
644 switch (chan->type) {
646 ret = vcnl4010_read_proxy_samp_freq(data, val, val2);
649 return IIO_VAL_INT_PLUS_MICRO;
658 static int vcnl4010_read_avail(struct iio_dev *indio_dev,
659 struct iio_chan_spec const *chan,
660 const int **vals, int *type, int *length,
664 case IIO_CHAN_INFO_SAMP_FREQ:
665 *vals = (int *)vcnl4010_prox_sampling_frequency;
666 *type = IIO_VAL_INT_PLUS_MICRO;
667 *length = 2 * ARRAY_SIZE(vcnl4010_prox_sampling_frequency);
668 return IIO_AVAIL_LIST;
674 static int vcnl4010_write_proxy_samp_freq(struct vcnl4000_data *data, int val,
680 for (i = 0; i < ARRAY_SIZE(vcnl4010_prox_sampling_frequency); i++) {
681 if (val == vcnl4010_prox_sampling_frequency[i][0] &&
682 val2 == vcnl4010_prox_sampling_frequency[i][1]) {
691 return i2c_smbus_write_byte_data(data->client, VCNL4010_PROX_RATE,
695 static int vcnl4010_write_raw(struct iio_dev *indio_dev,
696 struct iio_chan_spec const *chan,
697 int val, int val2, long mask)
700 struct vcnl4000_data *data = iio_priv(indio_dev);
702 ret = iio_device_claim_direct_mode(indio_dev);
706 /* Protect against event capture. */
707 if (vcnl4010_is_in_periodic_mode(data)) {
713 case IIO_CHAN_INFO_SAMP_FREQ:
714 switch (chan->type) {
716 ret = vcnl4010_write_proxy_samp_freq(data, val, val2);
728 iio_device_release_direct_mode(indio_dev);
732 static int vcnl4010_read_event(struct iio_dev *indio_dev,
733 const struct iio_chan_spec *chan,
734 enum iio_event_type type,
735 enum iio_event_direction dir,
736 enum iio_event_info info,
740 struct vcnl4000_data *data = iio_priv(indio_dev);
743 case IIO_EV_INFO_VALUE:
745 case IIO_EV_DIR_RISING:
746 ret = vcnl4000_read_data(data, VCNL4010_HIGH_THR_HI,
751 case IIO_EV_DIR_FALLING:
752 ret = vcnl4000_read_data(data, VCNL4010_LOW_THR_HI,
765 static int vcnl4010_write_event(struct iio_dev *indio_dev,
766 const struct iio_chan_spec *chan,
767 enum iio_event_type type,
768 enum iio_event_direction dir,
769 enum iio_event_info info,
773 struct vcnl4000_data *data = iio_priv(indio_dev);
776 case IIO_EV_INFO_VALUE:
778 case IIO_EV_DIR_RISING:
779 ret = vcnl4000_write_data(data, VCNL4010_HIGH_THR_HI,
784 case IIO_EV_DIR_FALLING:
785 ret = vcnl4000_write_data(data, VCNL4010_LOW_THR_HI,
798 static bool vcnl4010_is_thr_enabled(struct vcnl4000_data *data)
802 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_INT_CTRL);
806 return !!(ret & VCNL4010_INT_THR_EN);
809 static int vcnl4010_read_event_config(struct iio_dev *indio_dev,
810 const struct iio_chan_spec *chan,
811 enum iio_event_type type,
812 enum iio_event_direction dir)
814 struct vcnl4000_data *data = iio_priv(indio_dev);
816 switch (chan->type) {
818 return vcnl4010_is_thr_enabled(data);
824 static int vcnl4010_config_threshold(struct iio_dev *indio_dev, bool state)
826 struct vcnl4000_data *data = iio_priv(indio_dev);
832 ret = iio_device_claim_direct_mode(indio_dev);
836 /* Enable periodic measurement of proximity data. */
837 command = VCNL4000_SELF_TIMED_EN | VCNL4000_PROX_EN;
840 * Enable interrupts on threshold, for proximity data by
843 icr = VCNL4010_INT_THR_EN;
845 if (!vcnl4010_is_thr_enabled(data))
852 ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND,
857 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL, icr);
861 iio_device_release_direct_mode(indio_dev);
866 static int vcnl4010_write_event_config(struct iio_dev *indio_dev,
867 const struct iio_chan_spec *chan,
868 enum iio_event_type type,
869 enum iio_event_direction dir,
872 switch (chan->type) {
874 return vcnl4010_config_threshold(indio_dev, state);
880 static ssize_t vcnl4000_read_near_level(struct iio_dev *indio_dev,
882 const struct iio_chan_spec *chan,
885 struct vcnl4000_data *data = iio_priv(indio_dev);
887 return sprintf(buf, "%u\n", data->near_level);
890 static const struct iio_chan_spec_ext_info vcnl4000_ext_info[] = {
893 .shared = IIO_SEPARATE,
894 .read = vcnl4000_read_near_level,
899 static const struct iio_event_spec vcnl4000_event_spec[] = {
901 .type = IIO_EV_TYPE_THRESH,
902 .dir = IIO_EV_DIR_RISING,
903 .mask_separate = BIT(IIO_EV_INFO_VALUE),
905 .type = IIO_EV_TYPE_THRESH,
906 .dir = IIO_EV_DIR_FALLING,
907 .mask_separate = BIT(IIO_EV_INFO_VALUE),
909 .type = IIO_EV_TYPE_THRESH,
910 .dir = IIO_EV_DIR_EITHER,
911 .mask_separate = BIT(IIO_EV_INFO_ENABLE),
915 static const struct iio_chan_spec vcnl4000_channels[] = {
918 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
919 BIT(IIO_CHAN_INFO_SCALE),
921 .type = IIO_PROXIMITY,
922 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
923 .ext_info = vcnl4000_ext_info,
927 static const struct iio_chan_spec vcnl4010_channels[] = {
931 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
932 BIT(IIO_CHAN_INFO_SCALE),
934 .type = IIO_PROXIMITY,
936 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
937 BIT(IIO_CHAN_INFO_SAMP_FREQ),
938 .info_mask_separate_available = BIT(IIO_CHAN_INFO_SAMP_FREQ),
939 .event_spec = vcnl4000_event_spec,
940 .num_event_specs = ARRAY_SIZE(vcnl4000_event_spec),
941 .ext_info = vcnl4000_ext_info,
946 .endianness = IIO_CPU,
949 IIO_CHAN_SOFT_TIMESTAMP(1),
952 static const struct iio_chan_spec vcnl4040_channels[] = {
955 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
956 BIT(IIO_CHAN_INFO_SCALE),
958 .type = IIO_PROXIMITY,
959 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
960 BIT(IIO_CHAN_INFO_INT_TIME),
961 .info_mask_separate_available = BIT(IIO_CHAN_INFO_INT_TIME),
962 .ext_info = vcnl4000_ext_info,
966 static const struct iio_info vcnl4000_info = {
967 .read_raw = vcnl4000_read_raw,
970 static const struct iio_info vcnl4010_info = {
971 .read_raw = vcnl4010_read_raw,
972 .read_avail = vcnl4010_read_avail,
973 .write_raw = vcnl4010_write_raw,
974 .read_event_value = vcnl4010_read_event,
975 .write_event_value = vcnl4010_write_event,
976 .read_event_config = vcnl4010_read_event_config,
977 .write_event_config = vcnl4010_write_event_config,
980 static const struct iio_info vcnl4040_info = {
981 .read_raw = vcnl4000_read_raw,
982 .write_raw = vcnl4040_write_raw,
983 .read_avail = vcnl4040_read_avail,
986 static const struct vcnl4000_chip_spec vcnl4000_chip_spec_cfg[] = {
989 .init = vcnl4000_init,
990 .measure_light = vcnl4000_measure_light,
991 .measure_proximity = vcnl4000_measure_proximity,
992 .set_power_state = vcnl4000_set_power_state,
993 .channels = vcnl4000_channels,
994 .num_channels = ARRAY_SIZE(vcnl4000_channels),
995 .info = &vcnl4000_info,
996 .irq_support = false,
999 .prod = "VCNL4010/4020",
1000 .init = vcnl4000_init,
1001 .measure_light = vcnl4000_measure_light,
1002 .measure_proximity = vcnl4000_measure_proximity,
1003 .set_power_state = vcnl4000_set_power_state,
1004 .channels = vcnl4010_channels,
1005 .num_channels = ARRAY_SIZE(vcnl4010_channels),
1006 .info = &vcnl4010_info,
1007 .irq_support = true,
1011 .init = vcnl4200_init,
1012 .measure_light = vcnl4200_measure_light,
1013 .measure_proximity = vcnl4200_measure_proximity,
1014 .set_power_state = vcnl4200_set_power_state,
1015 .channels = vcnl4040_channels,
1016 .num_channels = ARRAY_SIZE(vcnl4040_channels),
1017 .info = &vcnl4040_info,
1018 .irq_support = false,
1022 .init = vcnl4200_init,
1023 .measure_light = vcnl4200_measure_light,
1024 .measure_proximity = vcnl4200_measure_proximity,
1025 .set_power_state = vcnl4200_set_power_state,
1026 .channels = vcnl4000_channels,
1027 .num_channels = ARRAY_SIZE(vcnl4000_channels),
1028 .info = &vcnl4000_info,
1029 .irq_support = false,
1033 static irqreturn_t vcnl4010_irq_thread(int irq, void *p)
1035 struct iio_dev *indio_dev = p;
1036 struct vcnl4000_data *data = iio_priv(indio_dev);
1040 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_ISR);
1046 if (isr & VCNL4010_INT_THR) {
1047 if (test_bit(VCNL4010_INT_THR_LOW, &isr)) {
1048 iio_push_event(indio_dev,
1049 IIO_UNMOD_EVENT_CODE(
1053 IIO_EV_DIR_FALLING),
1054 iio_get_time_ns(indio_dev));
1057 if (test_bit(VCNL4010_INT_THR_HIGH, &isr)) {
1058 iio_push_event(indio_dev,
1059 IIO_UNMOD_EVENT_CODE(
1064 iio_get_time_ns(indio_dev));
1067 i2c_smbus_write_byte_data(data->client, VCNL4010_ISR,
1068 isr & VCNL4010_INT_THR);
1071 if (isr & VCNL4010_INT_DRDY && iio_buffer_enabled(indio_dev))
1072 iio_trigger_poll_chained(indio_dev->trig);
1078 static irqreturn_t vcnl4010_trigger_handler(int irq, void *p)
1080 struct iio_poll_func *pf = p;
1081 struct iio_dev *indio_dev = pf->indio_dev;
1082 struct vcnl4000_data *data = iio_priv(indio_dev);
1083 const unsigned long *active_scan_mask = indio_dev->active_scan_mask;
1084 u16 buffer[8] __aligned(8) = {0}; /* 1x16-bit + naturally aligned ts */
1085 bool data_read = false;
1090 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_ISR);
1096 if (test_bit(0, active_scan_mask)) {
1097 if (test_bit(VCNL4010_INT_PROXIMITY, &isr)) {
1098 ret = vcnl4000_read_data(data,
1099 VCNL4000_PS_RESULT_HI,
1109 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_ISR,
1110 isr & VCNL4010_INT_DRDY);
1117 iio_push_to_buffers_with_timestamp(indio_dev, buffer,
1118 iio_get_time_ns(indio_dev));
1121 iio_trigger_notify_done(indio_dev->trig);
1125 static int vcnl4010_buffer_postenable(struct iio_dev *indio_dev)
1127 struct vcnl4000_data *data = iio_priv(indio_dev);
1131 /* Do not enable the buffer if we are already capturing events. */
1132 if (vcnl4010_is_in_periodic_mode(data))
1135 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL,
1136 VCNL4010_INT_PROX_EN);
1140 cmd = VCNL4000_SELF_TIMED_EN | VCNL4000_PROX_EN;
1141 return i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, cmd);
1144 static int vcnl4010_buffer_predisable(struct iio_dev *indio_dev)
1146 struct vcnl4000_data *data = iio_priv(indio_dev);
1149 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL, 0);
1153 return i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, 0);
1156 static const struct iio_buffer_setup_ops vcnl4010_buffer_ops = {
1157 .postenable = &vcnl4010_buffer_postenable,
1158 .predisable = &vcnl4010_buffer_predisable,
1161 static const struct iio_trigger_ops vcnl4010_trigger_ops = {
1162 .validate_device = iio_trigger_validate_own_device,
1165 static int vcnl4010_probe_trigger(struct iio_dev *indio_dev)
1167 struct vcnl4000_data *data = iio_priv(indio_dev);
1168 struct i2c_client *client = data->client;
1169 struct iio_trigger *trigger;
1171 trigger = devm_iio_trigger_alloc(&client->dev, "%s-dev%d",
1173 iio_device_id(indio_dev));
1177 trigger->ops = &vcnl4010_trigger_ops;
1178 iio_trigger_set_drvdata(trigger, indio_dev);
1180 return devm_iio_trigger_register(&client->dev, trigger);
1183 static int vcnl4000_probe(struct i2c_client *client)
1185 const struct i2c_device_id *id = i2c_client_get_device_id(client);
1186 struct vcnl4000_data *data;
1187 struct iio_dev *indio_dev;
1190 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
1194 data = iio_priv(indio_dev);
1195 i2c_set_clientdata(client, indio_dev);
1196 data->client = client;
1197 data->id = id->driver_data;
1198 data->chip_spec = &vcnl4000_chip_spec_cfg[data->id];
1200 ret = data->chip_spec->init(data);
1204 dev_dbg(&client->dev, "%s Ambient light/proximity sensor, Rev: %02x\n",
1205 data->chip_spec->prod, data->rev);
1207 if (device_property_read_u32(&client->dev, "proximity-near-level",
1209 data->near_level = 0;
1211 indio_dev->info = data->chip_spec->info;
1212 indio_dev->channels = data->chip_spec->channels;
1213 indio_dev->num_channels = data->chip_spec->num_channels;
1214 indio_dev->name = VCNL4000_DRV_NAME;
1215 indio_dev->modes = INDIO_DIRECT_MODE;
1217 if (client->irq && data->chip_spec->irq_support) {
1218 ret = devm_iio_triggered_buffer_setup(&client->dev, indio_dev,
1220 vcnl4010_trigger_handler,
1221 &vcnl4010_buffer_ops);
1223 dev_err(&client->dev,
1224 "unable to setup iio triggered buffer\n");
1228 ret = devm_request_threaded_irq(&client->dev, client->irq,
1229 NULL, vcnl4010_irq_thread,
1230 IRQF_TRIGGER_FALLING |
1235 dev_err(&client->dev, "irq request failed\n");
1239 ret = vcnl4010_probe_trigger(indio_dev);
1244 ret = pm_runtime_set_active(&client->dev);
1248 ret = iio_device_register(indio_dev);
1252 pm_runtime_enable(&client->dev);
1253 pm_runtime_set_autosuspend_delay(&client->dev, VCNL4000_SLEEP_DELAY_MS);
1254 pm_runtime_use_autosuspend(&client->dev);
1258 data->chip_spec->set_power_state(data, false);
1262 static const struct of_device_id vcnl_4000_of_match[] = {
1264 .compatible = "vishay,vcnl4000",
1265 .data = (void *)VCNL4000,
1268 .compatible = "vishay,vcnl4010",
1269 .data = (void *)VCNL4010,
1272 .compatible = "vishay,vcnl4020",
1273 .data = (void *)VCNL4010,
1276 .compatible = "vishay,vcnl4040",
1277 .data = (void *)VCNL4040,
1280 .compatible = "vishay,vcnl4200",
1281 .data = (void *)VCNL4200,
1285 MODULE_DEVICE_TABLE(of, vcnl_4000_of_match);
1287 static void vcnl4000_remove(struct i2c_client *client)
1289 struct iio_dev *indio_dev = i2c_get_clientdata(client);
1290 struct vcnl4000_data *data = iio_priv(indio_dev);
1293 pm_runtime_dont_use_autosuspend(&client->dev);
1294 pm_runtime_disable(&client->dev);
1295 iio_device_unregister(indio_dev);
1296 pm_runtime_set_suspended(&client->dev);
1298 ret = data->chip_spec->set_power_state(data, false);
1300 dev_warn(&client->dev, "Failed to power down (%pe)\n",
1304 static int vcnl4000_runtime_suspend(struct device *dev)
1306 struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
1307 struct vcnl4000_data *data = iio_priv(indio_dev);
1309 return data->chip_spec->set_power_state(data, false);
1312 static int vcnl4000_runtime_resume(struct device *dev)
1314 struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
1315 struct vcnl4000_data *data = iio_priv(indio_dev);
1317 return data->chip_spec->set_power_state(data, true);
1320 static DEFINE_RUNTIME_DEV_PM_OPS(vcnl4000_pm_ops, vcnl4000_runtime_suspend,
1321 vcnl4000_runtime_resume, NULL);
1323 static struct i2c_driver vcnl4000_driver = {
1325 .name = VCNL4000_DRV_NAME,
1326 .pm = pm_ptr(&vcnl4000_pm_ops),
1327 .of_match_table = vcnl_4000_of_match,
1329 .probe_new = vcnl4000_probe,
1330 .id_table = vcnl4000_id,
1331 .remove = vcnl4000_remove,
1334 module_i2c_driver(vcnl4000_driver);
1338 MODULE_DESCRIPTION("Vishay VCNL4000 proximity/ambient light sensor driver");
1339 MODULE_LICENSE("GPL");