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 VCNL4040_PS_THDL_LM 0x06 /* Proximity threshold low */
64 #define VCNL4040_PS_THDH_LM 0x07 /* Proximity threshold high */
65 #define VCNL4200_PS_DATA 0x08 /* Proximity data */
66 #define VCNL4200_AL_DATA 0x09 /* Ambient light data */
67 #define VCNL4040_INT_FLAGS 0x0b /* Interrupt register */
68 #define VCNL4200_DEV_ID 0x0e /* Device ID, slave address and version */
70 #define VCNL4040_DEV_ID 0x0c /* Device ID and version */
72 /* Bit masks for COMMAND register */
73 #define VCNL4000_AL_RDY BIT(6) /* ALS data ready? */
74 #define VCNL4000_PS_RDY BIT(5) /* proximity data ready? */
75 #define VCNL4000_AL_OD BIT(4) /* start on-demand ALS measurement */
76 #define VCNL4000_PS_OD BIT(3) /* start on-demand proximity measurement */
77 #define VCNL4000_ALS_EN BIT(2) /* start ALS measurement */
78 #define VCNL4000_PROX_EN BIT(1) /* start proximity measurement */
79 #define VCNL4000_SELF_TIMED_EN BIT(0) /* start self-timed measurement */
81 #define VCNL4040_ALS_CONF_ALS_SHUTDOWN BIT(0)
82 #define VCNL4040_PS_CONF1_PS_SHUTDOWN BIT(0)
83 #define VCNL4040_PS_CONF2_PS_IT GENMASK(3, 1) /* Proximity integration time */
84 #define VCNL4040_PS_CONF2_PS_INT GENMASK(9, 8) /* Proximity interrupt mode */
85 #define VCNL4040_PS_IF_AWAY BIT(8) /* Proximity event cross low threshold */
86 #define VCNL4040_PS_IF_CLOSE BIT(9) /* Proximity event cross high threshold */
88 /* Bit masks for interrupt registers. */
89 #define VCNL4010_INT_THR_SEL BIT(0) /* Select threshold interrupt source */
90 #define VCNL4010_INT_THR_EN BIT(1) /* Threshold interrupt type */
91 #define VCNL4010_INT_ALS_EN BIT(2) /* Enable on ALS data ready */
92 #define VCNL4010_INT_PROX_EN BIT(3) /* Enable on proximity data ready */
94 #define VCNL4010_INT_THR_HIGH 0 /* High threshold exceeded */
95 #define VCNL4010_INT_THR_LOW 1 /* Low threshold exceeded */
96 #define VCNL4010_INT_ALS 2 /* ALS data ready */
97 #define VCNL4010_INT_PROXIMITY 3 /* Proximity data ready */
99 #define VCNL4010_INT_THR \
100 (BIT(VCNL4010_INT_THR_LOW) | BIT(VCNL4010_INT_THR_HIGH))
101 #define VCNL4010_INT_DRDY \
102 (BIT(VCNL4010_INT_PROXIMITY) | BIT(VCNL4010_INT_ALS))
104 static const int vcnl4010_prox_sampling_frequency[][2] = {
115 static const int vcnl4040_ps_it_times[][2] = {
126 #define VCNL4000_SLEEP_DELAY_MS 2000 /* before we enter pm_runtime_suspend */
128 enum vcnl4000_device_ids {
135 struct vcnl4200_channel {
137 ktime_t last_measurement;
138 ktime_t sampling_rate;
142 struct vcnl4000_data {
143 struct i2c_client *client;
144 enum vcnl4000_device_ids id;
147 u8 ps_int; /* proximity interrupt mode */
148 const struct vcnl4000_chip_spec *chip_spec;
149 struct mutex vcnl4000_lock;
150 struct vcnl4200_channel vcnl4200_al;
151 struct vcnl4200_channel vcnl4200_ps;
155 struct vcnl4000_chip_spec {
157 struct iio_chan_spec const *channels;
158 const int num_channels;
159 const struct iio_info *info;
160 const struct iio_buffer_setup_ops *buffer_setup_ops;
161 int (*init)(struct vcnl4000_data *data);
162 int (*measure_light)(struct vcnl4000_data *data, int *val);
163 int (*measure_proximity)(struct vcnl4000_data *data, int *val);
164 int (*set_power_state)(struct vcnl4000_data *data, bool on);
165 irqreturn_t (*irq_thread)(int irq, void *priv);
166 irqreturn_t (*trig_buffer_func)(int irq, void *priv);
169 static const struct i2c_device_id vcnl4000_id[] = {
170 { "vcnl4000", VCNL4000 },
171 { "vcnl4010", VCNL4010 },
172 { "vcnl4020", VCNL4010 },
173 { "vcnl4040", VCNL4040 },
174 { "vcnl4200", VCNL4200 },
177 MODULE_DEVICE_TABLE(i2c, vcnl4000_id);
179 static int vcnl4000_set_power_state(struct vcnl4000_data *data, bool on)
185 static int vcnl4000_init(struct vcnl4000_data *data)
189 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_PROD_REV);
195 case VCNL4000_PROD_ID:
196 if (data->id != VCNL4000)
197 dev_warn(&data->client->dev,
198 "wrong device id, use vcnl4000");
200 case VCNL4010_PROD_ID:
201 if (data->id != VCNL4010)
202 dev_warn(&data->client->dev,
203 "wrong device id, use vcnl4010/4020");
209 data->rev = ret & 0xf;
210 data->al_scale = 250000;
212 return data->chip_spec->set_power_state(data, true);
215 static ssize_t vcnl4000_write_als_enable(struct vcnl4000_data *data, bool en)
219 mutex_lock(&data->vcnl4000_lock);
221 ret = i2c_smbus_read_word_data(data->client, VCNL4200_AL_CONF);
226 ret &= ~VCNL4040_ALS_CONF_ALS_SHUTDOWN;
228 ret |= VCNL4040_ALS_CONF_ALS_SHUTDOWN;
230 ret = i2c_smbus_write_word_data(data->client, VCNL4200_AL_CONF, ret);
233 mutex_unlock(&data->vcnl4000_lock);
238 static ssize_t vcnl4000_write_ps_enable(struct vcnl4000_data *data, bool en)
242 mutex_lock(&data->vcnl4000_lock);
244 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
249 ret &= ~VCNL4040_PS_CONF1_PS_SHUTDOWN;
251 ret |= VCNL4040_PS_CONF1_PS_SHUTDOWN;
253 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1, ret);
256 mutex_unlock(&data->vcnl4000_lock);
261 static int vcnl4200_set_power_state(struct vcnl4000_data *data, bool on)
265 /* Do not power down if interrupts are enabled */
266 if (!on && data->ps_int)
269 ret = vcnl4000_write_als_enable(data, on);
273 ret = vcnl4000_write_ps_enable(data, on);
278 /* Wait at least one integration cycle before fetching data */
279 data->vcnl4200_al.last_measurement = ktime_get();
280 data->vcnl4200_ps.last_measurement = ktime_get();
286 static int vcnl4200_init(struct vcnl4000_data *data)
290 ret = i2c_smbus_read_word_data(data->client, VCNL4200_DEV_ID);
296 if (id != VCNL4200_PROD_ID) {
297 ret = i2c_smbus_read_word_data(data->client, VCNL4040_DEV_ID);
303 if (id != VCNL4040_PROD_ID)
307 dev_dbg(&data->client->dev, "device id 0x%x", id);
309 data->rev = (ret >> 8) & 0xf;
312 data->vcnl4200_al.reg = VCNL4200_AL_DATA;
313 data->vcnl4200_ps.reg = VCNL4200_PS_DATA;
315 case VCNL4200_PROD_ID:
316 /* Default wait time is 50ms, add 20% tolerance. */
317 data->vcnl4200_al.sampling_rate = ktime_set(0, 60000 * 1000);
318 /* Default wait time is 4.8ms, add 20% tolerance. */
319 data->vcnl4200_ps.sampling_rate = ktime_set(0, 5760 * 1000);
320 data->al_scale = 24000;
322 case VCNL4040_PROD_ID:
323 /* Default wait time is 80ms, add 20% tolerance. */
324 data->vcnl4200_al.sampling_rate = ktime_set(0, 96000 * 1000);
325 /* Default wait time is 5ms, add 20% tolerance. */
326 data->vcnl4200_ps.sampling_rate = ktime_set(0, 6000 * 1000);
327 data->al_scale = 120000;
330 mutex_init(&data->vcnl4200_al.lock);
331 mutex_init(&data->vcnl4200_ps.lock);
333 ret = data->chip_spec->set_power_state(data, true);
340 static int vcnl4000_read_data(struct vcnl4000_data *data, u8 data_reg, int *val)
344 ret = i2c_smbus_read_word_swapped(data->client, data_reg);
352 static int vcnl4000_write_data(struct vcnl4000_data *data, u8 data_reg, int val)
357 return i2c_smbus_write_word_swapped(data->client, data_reg, val);
361 static int vcnl4000_measure(struct vcnl4000_data *data, u8 req_mask,
362 u8 rdy_mask, u8 data_reg, int *val)
367 mutex_lock(&data->vcnl4000_lock);
369 ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND,
374 /* wait for data to become ready */
376 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND);
381 msleep(20); /* measurement takes up to 100 ms */
385 dev_err(&data->client->dev,
386 "vcnl4000_measure() failed, data not ready\n");
391 ret = vcnl4000_read_data(data, data_reg, val);
395 mutex_unlock(&data->vcnl4000_lock);
400 mutex_unlock(&data->vcnl4000_lock);
404 static int vcnl4200_measure(struct vcnl4000_data *data,
405 struct vcnl4200_channel *chan, int *val)
409 ktime_t next_measurement;
411 mutex_lock(&chan->lock);
413 next_measurement = ktime_add(chan->last_measurement,
414 chan->sampling_rate);
415 delta = ktime_us_delta(next_measurement, ktime_get());
417 usleep_range(delta, delta + 500);
418 chan->last_measurement = ktime_get();
420 mutex_unlock(&chan->lock);
422 ret = i2c_smbus_read_word_data(data->client, chan->reg);
431 static int vcnl4000_measure_light(struct vcnl4000_data *data, int *val)
433 return vcnl4000_measure(data,
434 VCNL4000_AL_OD, VCNL4000_AL_RDY,
435 VCNL4000_AL_RESULT_HI, val);
438 static int vcnl4200_measure_light(struct vcnl4000_data *data, int *val)
440 return vcnl4200_measure(data, &data->vcnl4200_al, val);
443 static int vcnl4000_measure_proximity(struct vcnl4000_data *data, int *val)
445 return vcnl4000_measure(data,
446 VCNL4000_PS_OD, VCNL4000_PS_RDY,
447 VCNL4000_PS_RESULT_HI, val);
450 static int vcnl4200_measure_proximity(struct vcnl4000_data *data, int *val)
452 return vcnl4200_measure(data, &data->vcnl4200_ps, val);
455 static int vcnl4010_read_proxy_samp_freq(struct vcnl4000_data *data, int *val,
460 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_PROX_RATE);
464 if (ret >= ARRAY_SIZE(vcnl4010_prox_sampling_frequency))
467 *val = vcnl4010_prox_sampling_frequency[ret][0];
468 *val2 = vcnl4010_prox_sampling_frequency[ret][1];
473 static bool vcnl4010_is_in_periodic_mode(struct vcnl4000_data *data)
477 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND);
481 return !!(ret & VCNL4000_SELF_TIMED_EN);
484 static int vcnl4000_set_pm_runtime_state(struct vcnl4000_data *data, bool on)
486 struct device *dev = &data->client->dev;
490 ret = pm_runtime_resume_and_get(dev);
492 pm_runtime_mark_last_busy(dev);
493 ret = pm_runtime_put_autosuspend(dev);
499 static int vcnl4040_read_ps_it(struct vcnl4000_data *data, int *val, int *val2)
503 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
507 ret = FIELD_GET(VCNL4040_PS_CONF2_PS_IT, ret);
509 if (ret >= ARRAY_SIZE(vcnl4040_ps_it_times))
512 *val = vcnl4040_ps_it_times[ret][0];
513 *val2 = vcnl4040_ps_it_times[ret][1];
518 static ssize_t vcnl4040_write_ps_it(struct vcnl4000_data *data, int val)
524 for (i = 0; i < ARRAY_SIZE(vcnl4040_ps_it_times); i++) {
525 if (val == vcnl4040_ps_it_times[i][1]) {
534 mutex_lock(&data->vcnl4000_lock);
536 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
540 regval = (ret & ~VCNL4040_PS_CONF2_PS_IT) |
541 FIELD_PREP(VCNL4040_PS_CONF2_PS_IT, index);
542 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1,
546 mutex_unlock(&data->vcnl4000_lock);
550 static int vcnl4000_read_raw(struct iio_dev *indio_dev,
551 struct iio_chan_spec const *chan,
552 int *val, int *val2, long mask)
555 struct vcnl4000_data *data = iio_priv(indio_dev);
558 case IIO_CHAN_INFO_RAW:
559 ret = vcnl4000_set_pm_runtime_state(data, true);
563 switch (chan->type) {
565 ret = data->chip_spec->measure_light(data, val);
570 ret = data->chip_spec->measure_proximity(data, val);
577 vcnl4000_set_pm_runtime_state(data, false);
579 case IIO_CHAN_INFO_SCALE:
580 if (chan->type != IIO_LIGHT)
584 *val2 = data->al_scale;
585 return IIO_VAL_INT_PLUS_MICRO;
586 case IIO_CHAN_INFO_INT_TIME:
587 if (chan->type != IIO_PROXIMITY)
589 ret = vcnl4040_read_ps_it(data, val, val2);
592 return IIO_VAL_INT_PLUS_MICRO;
598 static int vcnl4040_write_raw(struct iio_dev *indio_dev,
599 struct iio_chan_spec const *chan,
600 int val, int val2, long mask)
602 struct vcnl4000_data *data = iio_priv(indio_dev);
605 case IIO_CHAN_INFO_INT_TIME:
608 if (chan->type != IIO_PROXIMITY)
610 return vcnl4040_write_ps_it(data, val2);
616 static int vcnl4040_read_avail(struct iio_dev *indio_dev,
617 struct iio_chan_spec const *chan,
618 const int **vals, int *type, int *length,
622 case IIO_CHAN_INFO_INT_TIME:
623 *vals = (int *)vcnl4040_ps_it_times;
624 *type = IIO_VAL_INT_PLUS_MICRO;
625 *length = 2 * ARRAY_SIZE(vcnl4040_ps_it_times);
626 return IIO_AVAIL_LIST;
632 static int vcnl4010_read_raw(struct iio_dev *indio_dev,
633 struct iio_chan_spec const *chan,
634 int *val, int *val2, long mask)
637 struct vcnl4000_data *data = iio_priv(indio_dev);
640 case IIO_CHAN_INFO_RAW:
641 case IIO_CHAN_INFO_SCALE:
642 ret = iio_device_claim_direct_mode(indio_dev);
646 /* Protect against event capture. */
647 if (vcnl4010_is_in_periodic_mode(data)) {
650 ret = vcnl4000_read_raw(indio_dev, chan, val, val2,
654 iio_device_release_direct_mode(indio_dev);
656 case IIO_CHAN_INFO_SAMP_FREQ:
657 switch (chan->type) {
659 ret = vcnl4010_read_proxy_samp_freq(data, val, val2);
662 return IIO_VAL_INT_PLUS_MICRO;
671 static int vcnl4010_read_avail(struct iio_dev *indio_dev,
672 struct iio_chan_spec const *chan,
673 const int **vals, int *type, int *length,
677 case IIO_CHAN_INFO_SAMP_FREQ:
678 *vals = (int *)vcnl4010_prox_sampling_frequency;
679 *type = IIO_VAL_INT_PLUS_MICRO;
680 *length = 2 * ARRAY_SIZE(vcnl4010_prox_sampling_frequency);
681 return IIO_AVAIL_LIST;
687 static int vcnl4010_write_proxy_samp_freq(struct vcnl4000_data *data, int val,
693 for (i = 0; i < ARRAY_SIZE(vcnl4010_prox_sampling_frequency); i++) {
694 if (val == vcnl4010_prox_sampling_frequency[i][0] &&
695 val2 == vcnl4010_prox_sampling_frequency[i][1]) {
704 return i2c_smbus_write_byte_data(data->client, VCNL4010_PROX_RATE,
708 static int vcnl4010_write_raw(struct iio_dev *indio_dev,
709 struct iio_chan_spec const *chan,
710 int val, int val2, long mask)
713 struct vcnl4000_data *data = iio_priv(indio_dev);
715 ret = iio_device_claim_direct_mode(indio_dev);
719 /* Protect against event capture. */
720 if (vcnl4010_is_in_periodic_mode(data)) {
726 case IIO_CHAN_INFO_SAMP_FREQ:
727 switch (chan->type) {
729 ret = vcnl4010_write_proxy_samp_freq(data, val, val2);
741 iio_device_release_direct_mode(indio_dev);
745 static int vcnl4010_read_event(struct iio_dev *indio_dev,
746 const struct iio_chan_spec *chan,
747 enum iio_event_type type,
748 enum iio_event_direction dir,
749 enum iio_event_info info,
753 struct vcnl4000_data *data = iio_priv(indio_dev);
756 case IIO_EV_INFO_VALUE:
758 case IIO_EV_DIR_RISING:
759 ret = vcnl4000_read_data(data, VCNL4010_HIGH_THR_HI,
764 case IIO_EV_DIR_FALLING:
765 ret = vcnl4000_read_data(data, VCNL4010_LOW_THR_HI,
778 static int vcnl4010_write_event(struct iio_dev *indio_dev,
779 const struct iio_chan_spec *chan,
780 enum iio_event_type type,
781 enum iio_event_direction dir,
782 enum iio_event_info info,
786 struct vcnl4000_data *data = iio_priv(indio_dev);
789 case IIO_EV_INFO_VALUE:
791 case IIO_EV_DIR_RISING:
792 ret = vcnl4000_write_data(data, VCNL4010_HIGH_THR_HI,
797 case IIO_EV_DIR_FALLING:
798 ret = vcnl4000_write_data(data, VCNL4010_LOW_THR_HI,
811 static int vcnl4040_read_event(struct iio_dev *indio_dev,
812 const struct iio_chan_spec *chan,
813 enum iio_event_type type,
814 enum iio_event_direction dir,
815 enum iio_event_info info,
819 struct vcnl4000_data *data = iio_priv(indio_dev);
822 case IIO_EV_DIR_RISING:
823 ret = i2c_smbus_read_word_data(data->client,
824 VCNL4040_PS_THDH_LM);
829 case IIO_EV_DIR_FALLING:
830 ret = i2c_smbus_read_word_data(data->client,
831 VCNL4040_PS_THDL_LM);
841 static int vcnl4040_write_event(struct iio_dev *indio_dev,
842 const struct iio_chan_spec *chan,
843 enum iio_event_type type,
844 enum iio_event_direction dir,
845 enum iio_event_info info,
849 struct vcnl4000_data *data = iio_priv(indio_dev);
852 case IIO_EV_DIR_RISING:
853 ret = i2c_smbus_write_word_data(data->client,
854 VCNL4040_PS_THDH_LM, val);
858 case IIO_EV_DIR_FALLING:
859 ret = i2c_smbus_write_word_data(data->client,
860 VCNL4040_PS_THDL_LM, val);
869 static bool vcnl4010_is_thr_enabled(struct vcnl4000_data *data)
873 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_INT_CTRL);
877 return !!(ret & VCNL4010_INT_THR_EN);
880 static int vcnl4010_read_event_config(struct iio_dev *indio_dev,
881 const struct iio_chan_spec *chan,
882 enum iio_event_type type,
883 enum iio_event_direction dir)
885 struct vcnl4000_data *data = iio_priv(indio_dev);
887 switch (chan->type) {
889 return vcnl4010_is_thr_enabled(data);
895 static int vcnl4010_config_threshold(struct iio_dev *indio_dev, bool state)
897 struct vcnl4000_data *data = iio_priv(indio_dev);
903 ret = iio_device_claim_direct_mode(indio_dev);
907 /* Enable periodic measurement of proximity data. */
908 command = VCNL4000_SELF_TIMED_EN | VCNL4000_PROX_EN;
911 * Enable interrupts on threshold, for proximity data by
914 icr = VCNL4010_INT_THR_EN;
916 if (!vcnl4010_is_thr_enabled(data))
923 ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND,
928 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL, icr);
932 iio_device_release_direct_mode(indio_dev);
937 static int vcnl4010_write_event_config(struct iio_dev *indio_dev,
938 const struct iio_chan_spec *chan,
939 enum iio_event_type type,
940 enum iio_event_direction dir,
943 switch (chan->type) {
945 return vcnl4010_config_threshold(indio_dev, state);
951 static int vcnl4040_read_event_config(struct iio_dev *indio_dev,
952 const struct iio_chan_spec *chan,
953 enum iio_event_type type,
954 enum iio_event_direction dir)
957 struct vcnl4000_data *data = iio_priv(indio_dev);
959 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
963 data->ps_int = FIELD_GET(VCNL4040_PS_CONF2_PS_INT, ret);
965 return (dir == IIO_EV_DIR_RISING) ?
966 FIELD_GET(VCNL4040_PS_IF_AWAY, ret) :
967 FIELD_GET(VCNL4040_PS_IF_CLOSE, ret);
970 static int vcnl4040_write_event_config(struct iio_dev *indio_dev,
971 const struct iio_chan_spec *chan,
972 enum iio_event_type type,
973 enum iio_event_direction dir, int state)
977 struct vcnl4000_data *data = iio_priv(indio_dev);
979 mutex_lock(&data->vcnl4000_lock);
981 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
985 if (dir == IIO_EV_DIR_RISING)
986 mask = VCNL4040_PS_IF_AWAY;
988 mask = VCNL4040_PS_IF_CLOSE;
990 val = state ? (ret | mask) : (ret & ~mask);
992 data->ps_int = FIELD_GET(VCNL4040_PS_CONF2_PS_INT, val);
993 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1, val);
996 mutex_unlock(&data->vcnl4000_lock);
997 data->chip_spec->set_power_state(data, data->ps_int != 0);
1002 static irqreturn_t vcnl4040_irq_thread(int irq, void *p)
1004 struct iio_dev *indio_dev = p;
1005 struct vcnl4000_data *data = iio_priv(indio_dev);
1008 ret = i2c_smbus_read_word_data(data->client, VCNL4040_INT_FLAGS);
1012 if (ret & VCNL4040_PS_IF_CLOSE) {
1013 iio_push_event(indio_dev,
1014 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
1017 iio_get_time_ns(indio_dev));
1020 if (ret & VCNL4040_PS_IF_AWAY) {
1021 iio_push_event(indio_dev,
1022 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
1024 IIO_EV_DIR_FALLING),
1025 iio_get_time_ns(indio_dev));
1031 static ssize_t vcnl4000_read_near_level(struct iio_dev *indio_dev,
1033 const struct iio_chan_spec *chan,
1036 struct vcnl4000_data *data = iio_priv(indio_dev);
1038 return sprintf(buf, "%u\n", data->near_level);
1041 static irqreturn_t vcnl4010_irq_thread(int irq, void *p)
1043 struct iio_dev *indio_dev = p;
1044 struct vcnl4000_data *data = iio_priv(indio_dev);
1048 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_ISR);
1054 if (isr & VCNL4010_INT_THR) {
1055 if (test_bit(VCNL4010_INT_THR_LOW, &isr)) {
1056 iio_push_event(indio_dev,
1057 IIO_UNMOD_EVENT_CODE(
1061 IIO_EV_DIR_FALLING),
1062 iio_get_time_ns(indio_dev));
1065 if (test_bit(VCNL4010_INT_THR_HIGH, &isr)) {
1066 iio_push_event(indio_dev,
1067 IIO_UNMOD_EVENT_CODE(
1072 iio_get_time_ns(indio_dev));
1075 i2c_smbus_write_byte_data(data->client, VCNL4010_ISR,
1076 isr & VCNL4010_INT_THR);
1079 if (isr & VCNL4010_INT_DRDY && iio_buffer_enabled(indio_dev))
1080 iio_trigger_poll_nested(indio_dev->trig);
1086 static irqreturn_t vcnl4010_trigger_handler(int irq, void *p)
1088 struct iio_poll_func *pf = p;
1089 struct iio_dev *indio_dev = pf->indio_dev;
1090 struct vcnl4000_data *data = iio_priv(indio_dev);
1091 const unsigned long *active_scan_mask = indio_dev->active_scan_mask;
1092 u16 buffer[8] __aligned(8) = {0}; /* 1x16-bit + naturally aligned ts */
1093 bool data_read = false;
1098 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_ISR);
1104 if (test_bit(0, active_scan_mask)) {
1105 if (test_bit(VCNL4010_INT_PROXIMITY, &isr)) {
1106 ret = vcnl4000_read_data(data,
1107 VCNL4000_PS_RESULT_HI,
1117 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_ISR,
1118 isr & VCNL4010_INT_DRDY);
1125 iio_push_to_buffers_with_timestamp(indio_dev, buffer,
1126 iio_get_time_ns(indio_dev));
1129 iio_trigger_notify_done(indio_dev->trig);
1133 static int vcnl4010_buffer_postenable(struct iio_dev *indio_dev)
1135 struct vcnl4000_data *data = iio_priv(indio_dev);
1139 /* Do not enable the buffer if we are already capturing events. */
1140 if (vcnl4010_is_in_periodic_mode(data))
1143 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL,
1144 VCNL4010_INT_PROX_EN);
1148 cmd = VCNL4000_SELF_TIMED_EN | VCNL4000_PROX_EN;
1149 return i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, cmd);
1152 static int vcnl4010_buffer_predisable(struct iio_dev *indio_dev)
1154 struct vcnl4000_data *data = iio_priv(indio_dev);
1157 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL, 0);
1161 return i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, 0);
1164 static const struct iio_buffer_setup_ops vcnl4010_buffer_ops = {
1165 .postenable = &vcnl4010_buffer_postenable,
1166 .predisable = &vcnl4010_buffer_predisable,
1169 static const struct iio_chan_spec_ext_info vcnl4000_ext_info[] = {
1171 .name = "nearlevel",
1172 .shared = IIO_SEPARATE,
1173 .read = vcnl4000_read_near_level,
1178 static const struct iio_event_spec vcnl4000_event_spec[] = {
1180 .type = IIO_EV_TYPE_THRESH,
1181 .dir = IIO_EV_DIR_RISING,
1182 .mask_separate = BIT(IIO_EV_INFO_VALUE),
1184 .type = IIO_EV_TYPE_THRESH,
1185 .dir = IIO_EV_DIR_FALLING,
1186 .mask_separate = BIT(IIO_EV_INFO_VALUE),
1188 .type = IIO_EV_TYPE_THRESH,
1189 .dir = IIO_EV_DIR_EITHER,
1190 .mask_separate = BIT(IIO_EV_INFO_ENABLE),
1194 static const struct iio_event_spec vcnl4040_event_spec[] = {
1196 .type = IIO_EV_TYPE_THRESH,
1197 .dir = IIO_EV_DIR_RISING,
1198 .mask_separate = BIT(IIO_EV_INFO_VALUE) | BIT(IIO_EV_INFO_ENABLE),
1200 .type = IIO_EV_TYPE_THRESH,
1201 .dir = IIO_EV_DIR_FALLING,
1202 .mask_separate = BIT(IIO_EV_INFO_VALUE) | BIT(IIO_EV_INFO_ENABLE),
1206 static const struct iio_chan_spec vcnl4000_channels[] = {
1209 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1210 BIT(IIO_CHAN_INFO_SCALE),
1212 .type = IIO_PROXIMITY,
1213 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
1214 .ext_info = vcnl4000_ext_info,
1218 static const struct iio_chan_spec vcnl4010_channels[] = {
1222 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1223 BIT(IIO_CHAN_INFO_SCALE),
1225 .type = IIO_PROXIMITY,
1227 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1228 BIT(IIO_CHAN_INFO_SAMP_FREQ),
1229 .info_mask_separate_available = BIT(IIO_CHAN_INFO_SAMP_FREQ),
1230 .event_spec = vcnl4000_event_spec,
1231 .num_event_specs = ARRAY_SIZE(vcnl4000_event_spec),
1232 .ext_info = vcnl4000_ext_info,
1237 .endianness = IIO_CPU,
1240 IIO_CHAN_SOFT_TIMESTAMP(1),
1243 static const struct iio_chan_spec vcnl4040_channels[] = {
1246 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1247 BIT(IIO_CHAN_INFO_SCALE),
1249 .type = IIO_PROXIMITY,
1250 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1251 BIT(IIO_CHAN_INFO_INT_TIME),
1252 .info_mask_separate_available = BIT(IIO_CHAN_INFO_INT_TIME),
1253 .ext_info = vcnl4000_ext_info,
1254 .event_spec = vcnl4040_event_spec,
1255 .num_event_specs = ARRAY_SIZE(vcnl4040_event_spec),
1259 static const struct iio_info vcnl4000_info = {
1260 .read_raw = vcnl4000_read_raw,
1263 static const struct iio_info vcnl4010_info = {
1264 .read_raw = vcnl4010_read_raw,
1265 .read_avail = vcnl4010_read_avail,
1266 .write_raw = vcnl4010_write_raw,
1267 .read_event_value = vcnl4010_read_event,
1268 .write_event_value = vcnl4010_write_event,
1269 .read_event_config = vcnl4010_read_event_config,
1270 .write_event_config = vcnl4010_write_event_config,
1273 static const struct iio_info vcnl4040_info = {
1274 .read_raw = vcnl4000_read_raw,
1275 .write_raw = vcnl4040_write_raw,
1276 .read_event_value = vcnl4040_read_event,
1277 .write_event_value = vcnl4040_write_event,
1278 .read_event_config = vcnl4040_read_event_config,
1279 .write_event_config = vcnl4040_write_event_config,
1280 .read_avail = vcnl4040_read_avail,
1283 static const struct vcnl4000_chip_spec vcnl4000_chip_spec_cfg[] = {
1286 .init = vcnl4000_init,
1287 .measure_light = vcnl4000_measure_light,
1288 .measure_proximity = vcnl4000_measure_proximity,
1289 .set_power_state = vcnl4000_set_power_state,
1290 .channels = vcnl4000_channels,
1291 .num_channels = ARRAY_SIZE(vcnl4000_channels),
1292 .info = &vcnl4000_info,
1295 .prod = "VCNL4010/4020",
1296 .init = vcnl4000_init,
1297 .measure_light = vcnl4000_measure_light,
1298 .measure_proximity = vcnl4000_measure_proximity,
1299 .set_power_state = vcnl4000_set_power_state,
1300 .channels = vcnl4010_channels,
1301 .num_channels = ARRAY_SIZE(vcnl4010_channels),
1302 .info = &vcnl4010_info,
1303 .irq_thread = vcnl4010_irq_thread,
1304 .trig_buffer_func = vcnl4010_trigger_handler,
1305 .buffer_setup_ops = &vcnl4010_buffer_ops,
1309 .init = vcnl4200_init,
1310 .measure_light = vcnl4200_measure_light,
1311 .measure_proximity = vcnl4200_measure_proximity,
1312 .set_power_state = vcnl4200_set_power_state,
1313 .channels = vcnl4040_channels,
1314 .num_channels = ARRAY_SIZE(vcnl4040_channels),
1315 .info = &vcnl4040_info,
1316 .irq_thread = vcnl4040_irq_thread,
1320 .init = vcnl4200_init,
1321 .measure_light = vcnl4200_measure_light,
1322 .measure_proximity = vcnl4200_measure_proximity,
1323 .set_power_state = vcnl4200_set_power_state,
1324 .channels = vcnl4000_channels,
1325 .num_channels = ARRAY_SIZE(vcnl4000_channels),
1326 .info = &vcnl4000_info,
1330 static const struct iio_trigger_ops vcnl4010_trigger_ops = {
1331 .validate_device = iio_trigger_validate_own_device,
1334 static int vcnl4010_probe_trigger(struct iio_dev *indio_dev)
1336 struct vcnl4000_data *data = iio_priv(indio_dev);
1337 struct i2c_client *client = data->client;
1338 struct iio_trigger *trigger;
1340 trigger = devm_iio_trigger_alloc(&client->dev, "%s-dev%d",
1342 iio_device_id(indio_dev));
1346 trigger->ops = &vcnl4010_trigger_ops;
1347 iio_trigger_set_drvdata(trigger, indio_dev);
1349 return devm_iio_trigger_register(&client->dev, trigger);
1352 static int vcnl4000_probe(struct i2c_client *client)
1354 const struct i2c_device_id *id = i2c_client_get_device_id(client);
1355 struct vcnl4000_data *data;
1356 struct iio_dev *indio_dev;
1359 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
1363 data = iio_priv(indio_dev);
1364 i2c_set_clientdata(client, indio_dev);
1365 data->client = client;
1366 data->id = id->driver_data;
1367 data->chip_spec = &vcnl4000_chip_spec_cfg[data->id];
1369 mutex_init(&data->vcnl4000_lock);
1371 ret = data->chip_spec->init(data);
1375 dev_dbg(&client->dev, "%s Ambient light/proximity sensor, Rev: %02x\n",
1376 data->chip_spec->prod, data->rev);
1378 if (device_property_read_u32(&client->dev, "proximity-near-level",
1380 data->near_level = 0;
1382 indio_dev->info = data->chip_spec->info;
1383 indio_dev->channels = data->chip_spec->channels;
1384 indio_dev->num_channels = data->chip_spec->num_channels;
1385 indio_dev->name = VCNL4000_DRV_NAME;
1386 indio_dev->modes = INDIO_DIRECT_MODE;
1388 if (data->chip_spec->trig_buffer_func &&
1389 data->chip_spec->buffer_setup_ops) {
1390 ret = devm_iio_triggered_buffer_setup(&client->dev, indio_dev,
1392 data->chip_spec->trig_buffer_func,
1393 data->chip_spec->buffer_setup_ops);
1395 dev_err(&client->dev,
1396 "unable to setup iio triggered buffer\n");
1401 if (client->irq && data->chip_spec->irq_thread) {
1402 ret = devm_request_threaded_irq(&client->dev, client->irq,
1403 NULL, data->chip_spec->irq_thread,
1404 IRQF_TRIGGER_FALLING |
1409 dev_err(&client->dev, "irq request failed\n");
1413 ret = vcnl4010_probe_trigger(indio_dev);
1418 ret = pm_runtime_set_active(&client->dev);
1422 ret = iio_device_register(indio_dev);
1426 pm_runtime_enable(&client->dev);
1427 pm_runtime_set_autosuspend_delay(&client->dev, VCNL4000_SLEEP_DELAY_MS);
1428 pm_runtime_use_autosuspend(&client->dev);
1432 data->chip_spec->set_power_state(data, false);
1436 static const struct of_device_id vcnl_4000_of_match[] = {
1438 .compatible = "vishay,vcnl4000",
1439 .data = (void *)VCNL4000,
1442 .compatible = "vishay,vcnl4010",
1443 .data = (void *)VCNL4010,
1446 .compatible = "vishay,vcnl4020",
1447 .data = (void *)VCNL4010,
1450 .compatible = "vishay,vcnl4040",
1451 .data = (void *)VCNL4040,
1454 .compatible = "vishay,vcnl4200",
1455 .data = (void *)VCNL4200,
1459 MODULE_DEVICE_TABLE(of, vcnl_4000_of_match);
1461 static void vcnl4000_remove(struct i2c_client *client)
1463 struct iio_dev *indio_dev = i2c_get_clientdata(client);
1464 struct vcnl4000_data *data = iio_priv(indio_dev);
1467 pm_runtime_dont_use_autosuspend(&client->dev);
1468 pm_runtime_disable(&client->dev);
1469 iio_device_unregister(indio_dev);
1470 pm_runtime_set_suspended(&client->dev);
1472 ret = data->chip_spec->set_power_state(data, false);
1474 dev_warn(&client->dev, "Failed to power down (%pe)\n",
1478 static int vcnl4000_runtime_suspend(struct device *dev)
1480 struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
1481 struct vcnl4000_data *data = iio_priv(indio_dev);
1483 return data->chip_spec->set_power_state(data, false);
1486 static int vcnl4000_runtime_resume(struct device *dev)
1488 struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
1489 struct vcnl4000_data *data = iio_priv(indio_dev);
1491 return data->chip_spec->set_power_state(data, true);
1494 static DEFINE_RUNTIME_DEV_PM_OPS(vcnl4000_pm_ops, vcnl4000_runtime_suspend,
1495 vcnl4000_runtime_resume, NULL);
1497 static struct i2c_driver vcnl4000_driver = {
1499 .name = VCNL4000_DRV_NAME,
1500 .pm = pm_ptr(&vcnl4000_pm_ops),
1501 .of_match_table = vcnl_4000_of_match,
1503 .probe_new = vcnl4000_probe,
1504 .id_table = vcnl4000_id,
1505 .remove = vcnl4000_remove,
1508 module_i2c_driver(vcnl4000_driver);
1512 MODULE_DESCRIPTION("Vishay VCNL4000 proximity/ambient light sensor driver");
1513 MODULE_LICENSE("GPL");