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
6 * Copyright 2012 Peter Meerwald <pmeerw@pmeerw.net>
7 * Copyright 2019 Pursim SPC
8 * Copyright 2020 Mathieu Othacehe <m.othacehe@gmail.com>
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;
211 mutex_init(&data->vcnl4000_lock);
213 return data->chip_spec->set_power_state(data, true);
216 static ssize_t vcnl4000_write_als_enable(struct vcnl4000_data *data, bool en)
220 mutex_lock(&data->vcnl4000_lock);
222 ret = i2c_smbus_read_word_data(data->client, VCNL4200_AL_CONF);
227 ret &= ~VCNL4040_ALS_CONF_ALS_SHUTDOWN;
229 ret |= VCNL4040_ALS_CONF_ALS_SHUTDOWN;
231 ret = i2c_smbus_write_word_data(data->client, VCNL4200_AL_CONF, ret);
234 mutex_unlock(&data->vcnl4000_lock);
239 static ssize_t vcnl4000_write_ps_enable(struct vcnl4000_data *data, bool en)
243 mutex_lock(&data->vcnl4000_lock);
245 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
250 ret &= ~VCNL4040_PS_CONF1_PS_SHUTDOWN;
252 ret |= VCNL4040_PS_CONF1_PS_SHUTDOWN;
254 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1, ret);
257 mutex_unlock(&data->vcnl4000_lock);
262 static int vcnl4200_set_power_state(struct vcnl4000_data *data, bool on)
266 /* Do not power down if interrupts are enabled */
267 if (!on && data->ps_int)
270 ret = vcnl4000_write_als_enable(data, on);
274 ret = vcnl4000_write_ps_enable(data, on);
279 /* Wait at least one integration cycle before fetching data */
280 data->vcnl4200_al.last_measurement = ktime_get();
281 data->vcnl4200_ps.last_measurement = ktime_get();
287 static int vcnl4200_init(struct vcnl4000_data *data)
291 ret = i2c_smbus_read_word_data(data->client, VCNL4200_DEV_ID);
297 if (id != VCNL4200_PROD_ID) {
298 ret = i2c_smbus_read_word_data(data->client, VCNL4040_DEV_ID);
304 if (id != VCNL4040_PROD_ID)
308 dev_dbg(&data->client->dev, "device id 0x%x", id);
310 data->rev = (ret >> 8) & 0xf;
313 data->vcnl4200_al.reg = VCNL4200_AL_DATA;
314 data->vcnl4200_ps.reg = VCNL4200_PS_DATA;
316 case VCNL4200_PROD_ID:
317 /* Default wait time is 50ms, add 20% tolerance. */
318 data->vcnl4200_al.sampling_rate = ktime_set(0, 60000 * 1000);
319 /* Default wait time is 4.8ms, add 20% tolerance. */
320 data->vcnl4200_ps.sampling_rate = ktime_set(0, 5760 * 1000);
321 data->al_scale = 24000;
323 case VCNL4040_PROD_ID:
324 /* Default wait time is 80ms, add 20% tolerance. */
325 data->vcnl4200_al.sampling_rate = ktime_set(0, 96000 * 1000);
326 /* Default wait time is 5ms, add 20% tolerance. */
327 data->vcnl4200_ps.sampling_rate = ktime_set(0, 6000 * 1000);
328 data->al_scale = 120000;
331 mutex_init(&data->vcnl4200_al.lock);
332 mutex_init(&data->vcnl4200_ps.lock);
334 ret = data->chip_spec->set_power_state(data, true);
341 static int vcnl4000_read_data(struct vcnl4000_data *data, u8 data_reg, int *val)
345 ret = i2c_smbus_read_word_swapped(data->client, data_reg);
353 static int vcnl4000_write_data(struct vcnl4000_data *data, u8 data_reg, int val)
358 return i2c_smbus_write_word_swapped(data->client, data_reg, val);
362 static int vcnl4000_measure(struct vcnl4000_data *data, u8 req_mask,
363 u8 rdy_mask, u8 data_reg, int *val)
368 mutex_lock(&data->vcnl4000_lock);
370 ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND,
375 /* wait for data to become ready */
377 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND);
382 msleep(20); /* measurement takes up to 100 ms */
386 dev_err(&data->client->dev,
387 "vcnl4000_measure() failed, data not ready\n");
392 ret = vcnl4000_read_data(data, data_reg, val);
396 mutex_unlock(&data->vcnl4000_lock);
401 mutex_unlock(&data->vcnl4000_lock);
405 static int vcnl4200_measure(struct vcnl4000_data *data,
406 struct vcnl4200_channel *chan, int *val)
410 ktime_t next_measurement;
412 mutex_lock(&chan->lock);
414 next_measurement = ktime_add(chan->last_measurement,
415 chan->sampling_rate);
416 delta = ktime_us_delta(next_measurement, ktime_get());
418 usleep_range(delta, delta + 500);
419 chan->last_measurement = ktime_get();
421 mutex_unlock(&chan->lock);
423 ret = i2c_smbus_read_word_data(data->client, chan->reg);
432 static int vcnl4000_measure_light(struct vcnl4000_data *data, int *val)
434 return vcnl4000_measure(data,
435 VCNL4000_AL_OD, VCNL4000_AL_RDY,
436 VCNL4000_AL_RESULT_HI, val);
439 static int vcnl4200_measure_light(struct vcnl4000_data *data, int *val)
441 return vcnl4200_measure(data, &data->vcnl4200_al, val);
444 static int vcnl4000_measure_proximity(struct vcnl4000_data *data, int *val)
446 return vcnl4000_measure(data,
447 VCNL4000_PS_OD, VCNL4000_PS_RDY,
448 VCNL4000_PS_RESULT_HI, val);
451 static int vcnl4200_measure_proximity(struct vcnl4000_data *data, int *val)
453 return vcnl4200_measure(data, &data->vcnl4200_ps, val);
456 static int vcnl4010_read_proxy_samp_freq(struct vcnl4000_data *data, int *val,
461 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_PROX_RATE);
465 if (ret >= ARRAY_SIZE(vcnl4010_prox_sampling_frequency))
468 *val = vcnl4010_prox_sampling_frequency[ret][0];
469 *val2 = vcnl4010_prox_sampling_frequency[ret][1];
474 static bool vcnl4010_is_in_periodic_mode(struct vcnl4000_data *data)
478 ret = i2c_smbus_read_byte_data(data->client, VCNL4000_COMMAND);
482 return !!(ret & VCNL4000_SELF_TIMED_EN);
485 static int vcnl4000_set_pm_runtime_state(struct vcnl4000_data *data, bool on)
487 struct device *dev = &data->client->dev;
491 ret = pm_runtime_resume_and_get(dev);
493 pm_runtime_mark_last_busy(dev);
494 ret = pm_runtime_put_autosuspend(dev);
500 static int vcnl4040_read_ps_it(struct vcnl4000_data *data, int *val, int *val2)
504 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
508 ret = FIELD_GET(VCNL4040_PS_CONF2_PS_IT, ret);
510 if (ret >= ARRAY_SIZE(vcnl4040_ps_it_times))
513 *val = vcnl4040_ps_it_times[ret][0];
514 *val2 = vcnl4040_ps_it_times[ret][1];
519 static ssize_t vcnl4040_write_ps_it(struct vcnl4000_data *data, int val)
525 for (i = 0; i < ARRAY_SIZE(vcnl4040_ps_it_times); i++) {
526 if (val == vcnl4040_ps_it_times[i][1]) {
535 mutex_lock(&data->vcnl4000_lock);
537 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
541 regval = (ret & ~VCNL4040_PS_CONF2_PS_IT) |
542 FIELD_PREP(VCNL4040_PS_CONF2_PS_IT, index);
543 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1,
547 mutex_unlock(&data->vcnl4000_lock);
551 static int vcnl4000_read_raw(struct iio_dev *indio_dev,
552 struct iio_chan_spec const *chan,
553 int *val, int *val2, long mask)
556 struct vcnl4000_data *data = iio_priv(indio_dev);
559 case IIO_CHAN_INFO_RAW:
560 ret = vcnl4000_set_pm_runtime_state(data, true);
564 switch (chan->type) {
566 ret = data->chip_spec->measure_light(data, val);
571 ret = data->chip_spec->measure_proximity(data, val);
578 vcnl4000_set_pm_runtime_state(data, false);
580 case IIO_CHAN_INFO_SCALE:
581 if (chan->type != IIO_LIGHT)
585 *val2 = data->al_scale;
586 return IIO_VAL_INT_PLUS_MICRO;
587 case IIO_CHAN_INFO_INT_TIME:
588 if (chan->type != IIO_PROXIMITY)
590 ret = vcnl4040_read_ps_it(data, val, val2);
593 return IIO_VAL_INT_PLUS_MICRO;
599 static int vcnl4040_write_raw(struct iio_dev *indio_dev,
600 struct iio_chan_spec const *chan,
601 int val, int val2, long mask)
603 struct vcnl4000_data *data = iio_priv(indio_dev);
606 case IIO_CHAN_INFO_INT_TIME:
609 if (chan->type != IIO_PROXIMITY)
611 return vcnl4040_write_ps_it(data, val2);
617 static int vcnl4040_read_avail(struct iio_dev *indio_dev,
618 struct iio_chan_spec const *chan,
619 const int **vals, int *type, int *length,
623 case IIO_CHAN_INFO_INT_TIME:
624 *vals = (int *)vcnl4040_ps_it_times;
625 *type = IIO_VAL_INT_PLUS_MICRO;
626 *length = 2 * ARRAY_SIZE(vcnl4040_ps_it_times);
627 return IIO_AVAIL_LIST;
633 static int vcnl4010_read_raw(struct iio_dev *indio_dev,
634 struct iio_chan_spec const *chan,
635 int *val, int *val2, long mask)
638 struct vcnl4000_data *data = iio_priv(indio_dev);
641 case IIO_CHAN_INFO_RAW:
642 case IIO_CHAN_INFO_SCALE:
643 ret = iio_device_claim_direct_mode(indio_dev);
647 /* Protect against event capture. */
648 if (vcnl4010_is_in_periodic_mode(data)) {
651 ret = vcnl4000_read_raw(indio_dev, chan, val, val2,
655 iio_device_release_direct_mode(indio_dev);
657 case IIO_CHAN_INFO_SAMP_FREQ:
658 switch (chan->type) {
660 ret = vcnl4010_read_proxy_samp_freq(data, val, val2);
663 return IIO_VAL_INT_PLUS_MICRO;
672 static int vcnl4010_read_avail(struct iio_dev *indio_dev,
673 struct iio_chan_spec const *chan,
674 const int **vals, int *type, int *length,
678 case IIO_CHAN_INFO_SAMP_FREQ:
679 *vals = (int *)vcnl4010_prox_sampling_frequency;
680 *type = IIO_VAL_INT_PLUS_MICRO;
681 *length = 2 * ARRAY_SIZE(vcnl4010_prox_sampling_frequency);
682 return IIO_AVAIL_LIST;
688 static int vcnl4010_write_proxy_samp_freq(struct vcnl4000_data *data, int val,
694 for (i = 0; i < ARRAY_SIZE(vcnl4010_prox_sampling_frequency); i++) {
695 if (val == vcnl4010_prox_sampling_frequency[i][0] &&
696 val2 == vcnl4010_prox_sampling_frequency[i][1]) {
705 return i2c_smbus_write_byte_data(data->client, VCNL4010_PROX_RATE,
709 static int vcnl4010_write_raw(struct iio_dev *indio_dev,
710 struct iio_chan_spec const *chan,
711 int val, int val2, long mask)
714 struct vcnl4000_data *data = iio_priv(indio_dev);
716 ret = iio_device_claim_direct_mode(indio_dev);
720 /* Protect against event capture. */
721 if (vcnl4010_is_in_periodic_mode(data)) {
727 case IIO_CHAN_INFO_SAMP_FREQ:
728 switch (chan->type) {
730 ret = vcnl4010_write_proxy_samp_freq(data, val, val2);
742 iio_device_release_direct_mode(indio_dev);
746 static int vcnl4010_read_event(struct iio_dev *indio_dev,
747 const struct iio_chan_spec *chan,
748 enum iio_event_type type,
749 enum iio_event_direction dir,
750 enum iio_event_info info,
754 struct vcnl4000_data *data = iio_priv(indio_dev);
757 case IIO_EV_INFO_VALUE:
759 case IIO_EV_DIR_RISING:
760 ret = vcnl4000_read_data(data, VCNL4010_HIGH_THR_HI,
765 case IIO_EV_DIR_FALLING:
766 ret = vcnl4000_read_data(data, VCNL4010_LOW_THR_HI,
779 static int vcnl4010_write_event(struct iio_dev *indio_dev,
780 const struct iio_chan_spec *chan,
781 enum iio_event_type type,
782 enum iio_event_direction dir,
783 enum iio_event_info info,
787 struct vcnl4000_data *data = iio_priv(indio_dev);
790 case IIO_EV_INFO_VALUE:
792 case IIO_EV_DIR_RISING:
793 ret = vcnl4000_write_data(data, VCNL4010_HIGH_THR_HI,
798 case IIO_EV_DIR_FALLING:
799 ret = vcnl4000_write_data(data, VCNL4010_LOW_THR_HI,
812 static int vcnl4040_read_event(struct iio_dev *indio_dev,
813 const struct iio_chan_spec *chan,
814 enum iio_event_type type,
815 enum iio_event_direction dir,
816 enum iio_event_info info,
820 struct vcnl4000_data *data = iio_priv(indio_dev);
823 case IIO_EV_DIR_RISING:
824 ret = i2c_smbus_read_word_data(data->client,
825 VCNL4040_PS_THDH_LM);
830 case IIO_EV_DIR_FALLING:
831 ret = i2c_smbus_read_word_data(data->client,
832 VCNL4040_PS_THDL_LM);
842 static int vcnl4040_write_event(struct iio_dev *indio_dev,
843 const struct iio_chan_spec *chan,
844 enum iio_event_type type,
845 enum iio_event_direction dir,
846 enum iio_event_info info,
850 struct vcnl4000_data *data = iio_priv(indio_dev);
853 case IIO_EV_DIR_RISING:
854 ret = i2c_smbus_write_word_data(data->client,
855 VCNL4040_PS_THDH_LM, val);
859 case IIO_EV_DIR_FALLING:
860 ret = i2c_smbus_write_word_data(data->client,
861 VCNL4040_PS_THDL_LM, val);
870 static bool vcnl4010_is_thr_enabled(struct vcnl4000_data *data)
874 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_INT_CTRL);
878 return !!(ret & VCNL4010_INT_THR_EN);
881 static int vcnl4010_read_event_config(struct iio_dev *indio_dev,
882 const struct iio_chan_spec *chan,
883 enum iio_event_type type,
884 enum iio_event_direction dir)
886 struct vcnl4000_data *data = iio_priv(indio_dev);
888 switch (chan->type) {
890 return vcnl4010_is_thr_enabled(data);
896 static int vcnl4010_config_threshold(struct iio_dev *indio_dev, bool state)
898 struct vcnl4000_data *data = iio_priv(indio_dev);
904 ret = iio_device_claim_direct_mode(indio_dev);
908 /* Enable periodic measurement of proximity data. */
909 command = VCNL4000_SELF_TIMED_EN | VCNL4000_PROX_EN;
912 * Enable interrupts on threshold, for proximity data by
915 icr = VCNL4010_INT_THR_EN;
917 if (!vcnl4010_is_thr_enabled(data))
924 ret = i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND,
929 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL, icr);
933 iio_device_release_direct_mode(indio_dev);
938 static int vcnl4010_write_event_config(struct iio_dev *indio_dev,
939 const struct iio_chan_spec *chan,
940 enum iio_event_type type,
941 enum iio_event_direction dir,
944 switch (chan->type) {
946 return vcnl4010_config_threshold(indio_dev, state);
952 static int vcnl4040_read_event_config(struct iio_dev *indio_dev,
953 const struct iio_chan_spec *chan,
954 enum iio_event_type type,
955 enum iio_event_direction dir)
958 struct vcnl4000_data *data = iio_priv(indio_dev);
960 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
964 data->ps_int = FIELD_GET(VCNL4040_PS_CONF2_PS_INT, ret);
966 return (dir == IIO_EV_DIR_RISING) ?
967 FIELD_GET(VCNL4040_PS_IF_AWAY, ret) :
968 FIELD_GET(VCNL4040_PS_IF_CLOSE, ret);
971 static int vcnl4040_write_event_config(struct iio_dev *indio_dev,
972 const struct iio_chan_spec *chan,
973 enum iio_event_type type,
974 enum iio_event_direction dir, int state)
978 struct vcnl4000_data *data = iio_priv(indio_dev);
980 mutex_lock(&data->vcnl4000_lock);
982 ret = i2c_smbus_read_word_data(data->client, VCNL4200_PS_CONF1);
986 if (dir == IIO_EV_DIR_RISING)
987 mask = VCNL4040_PS_IF_AWAY;
989 mask = VCNL4040_PS_IF_CLOSE;
991 val = state ? (ret | mask) : (ret & ~mask);
993 data->ps_int = FIELD_GET(VCNL4040_PS_CONF2_PS_INT, val);
994 ret = i2c_smbus_write_word_data(data->client, VCNL4200_PS_CONF1, val);
997 mutex_unlock(&data->vcnl4000_lock);
998 data->chip_spec->set_power_state(data, data->ps_int != 0);
1003 static irqreturn_t vcnl4040_irq_thread(int irq, void *p)
1005 struct iio_dev *indio_dev = p;
1006 struct vcnl4000_data *data = iio_priv(indio_dev);
1009 ret = i2c_smbus_read_word_data(data->client, VCNL4040_INT_FLAGS);
1013 if (ret & VCNL4040_PS_IF_CLOSE) {
1014 iio_push_event(indio_dev,
1015 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
1018 iio_get_time_ns(indio_dev));
1021 if (ret & VCNL4040_PS_IF_AWAY) {
1022 iio_push_event(indio_dev,
1023 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
1025 IIO_EV_DIR_FALLING),
1026 iio_get_time_ns(indio_dev));
1032 static ssize_t vcnl4000_read_near_level(struct iio_dev *indio_dev,
1034 const struct iio_chan_spec *chan,
1037 struct vcnl4000_data *data = iio_priv(indio_dev);
1039 return sprintf(buf, "%u\n", data->near_level);
1042 static irqreturn_t vcnl4010_irq_thread(int irq, void *p)
1044 struct iio_dev *indio_dev = p;
1045 struct vcnl4000_data *data = iio_priv(indio_dev);
1049 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_ISR);
1055 if (isr & VCNL4010_INT_THR) {
1056 if (test_bit(VCNL4010_INT_THR_LOW, &isr)) {
1057 iio_push_event(indio_dev,
1058 IIO_UNMOD_EVENT_CODE(
1062 IIO_EV_DIR_FALLING),
1063 iio_get_time_ns(indio_dev));
1066 if (test_bit(VCNL4010_INT_THR_HIGH, &isr)) {
1067 iio_push_event(indio_dev,
1068 IIO_UNMOD_EVENT_CODE(
1073 iio_get_time_ns(indio_dev));
1076 i2c_smbus_write_byte_data(data->client, VCNL4010_ISR,
1077 isr & VCNL4010_INT_THR);
1080 if (isr & VCNL4010_INT_DRDY && iio_buffer_enabled(indio_dev))
1081 iio_trigger_poll_chained(indio_dev->trig);
1087 static irqreturn_t vcnl4010_trigger_handler(int irq, void *p)
1089 struct iio_poll_func *pf = p;
1090 struct iio_dev *indio_dev = pf->indio_dev;
1091 struct vcnl4000_data *data = iio_priv(indio_dev);
1092 const unsigned long *active_scan_mask = indio_dev->active_scan_mask;
1093 u16 buffer[8] __aligned(8) = {0}; /* 1x16-bit + naturally aligned ts */
1094 bool data_read = false;
1099 ret = i2c_smbus_read_byte_data(data->client, VCNL4010_ISR);
1105 if (test_bit(0, active_scan_mask)) {
1106 if (test_bit(VCNL4010_INT_PROXIMITY, &isr)) {
1107 ret = vcnl4000_read_data(data,
1108 VCNL4000_PS_RESULT_HI,
1118 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_ISR,
1119 isr & VCNL4010_INT_DRDY);
1126 iio_push_to_buffers_with_timestamp(indio_dev, buffer,
1127 iio_get_time_ns(indio_dev));
1130 iio_trigger_notify_done(indio_dev->trig);
1134 static int vcnl4010_buffer_postenable(struct iio_dev *indio_dev)
1136 struct vcnl4000_data *data = iio_priv(indio_dev);
1140 /* Do not enable the buffer if we are already capturing events. */
1141 if (vcnl4010_is_in_periodic_mode(data))
1144 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL,
1145 VCNL4010_INT_PROX_EN);
1149 cmd = VCNL4000_SELF_TIMED_EN | VCNL4000_PROX_EN;
1150 return i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, cmd);
1153 static int vcnl4010_buffer_predisable(struct iio_dev *indio_dev)
1155 struct vcnl4000_data *data = iio_priv(indio_dev);
1158 ret = i2c_smbus_write_byte_data(data->client, VCNL4010_INT_CTRL, 0);
1162 return i2c_smbus_write_byte_data(data->client, VCNL4000_COMMAND, 0);
1165 static const struct iio_buffer_setup_ops vcnl4010_buffer_ops = {
1166 .postenable = &vcnl4010_buffer_postenable,
1167 .predisable = &vcnl4010_buffer_predisable,
1170 static const struct iio_chan_spec_ext_info vcnl4000_ext_info[] = {
1172 .name = "nearlevel",
1173 .shared = IIO_SEPARATE,
1174 .read = vcnl4000_read_near_level,
1179 static const struct iio_event_spec vcnl4000_event_spec[] = {
1181 .type = IIO_EV_TYPE_THRESH,
1182 .dir = IIO_EV_DIR_RISING,
1183 .mask_separate = BIT(IIO_EV_INFO_VALUE),
1185 .type = IIO_EV_TYPE_THRESH,
1186 .dir = IIO_EV_DIR_FALLING,
1187 .mask_separate = BIT(IIO_EV_INFO_VALUE),
1189 .type = IIO_EV_TYPE_THRESH,
1190 .dir = IIO_EV_DIR_EITHER,
1191 .mask_separate = BIT(IIO_EV_INFO_ENABLE),
1195 static const struct iio_event_spec vcnl4040_event_spec[] = {
1197 .type = IIO_EV_TYPE_THRESH,
1198 .dir = IIO_EV_DIR_RISING,
1199 .mask_separate = BIT(IIO_EV_INFO_VALUE) | BIT(IIO_EV_INFO_ENABLE),
1201 .type = IIO_EV_TYPE_THRESH,
1202 .dir = IIO_EV_DIR_FALLING,
1203 .mask_separate = BIT(IIO_EV_INFO_VALUE) | BIT(IIO_EV_INFO_ENABLE),
1207 static const struct iio_chan_spec vcnl4000_channels[] = {
1210 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1211 BIT(IIO_CHAN_INFO_SCALE),
1213 .type = IIO_PROXIMITY,
1214 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
1215 .ext_info = vcnl4000_ext_info,
1219 static const struct iio_chan_spec vcnl4010_channels[] = {
1223 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1224 BIT(IIO_CHAN_INFO_SCALE),
1226 .type = IIO_PROXIMITY,
1228 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1229 BIT(IIO_CHAN_INFO_SAMP_FREQ),
1230 .info_mask_separate_available = BIT(IIO_CHAN_INFO_SAMP_FREQ),
1231 .event_spec = vcnl4000_event_spec,
1232 .num_event_specs = ARRAY_SIZE(vcnl4000_event_spec),
1233 .ext_info = vcnl4000_ext_info,
1238 .endianness = IIO_CPU,
1241 IIO_CHAN_SOFT_TIMESTAMP(1),
1244 static const struct iio_chan_spec vcnl4040_channels[] = {
1247 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1248 BIT(IIO_CHAN_INFO_SCALE),
1250 .type = IIO_PROXIMITY,
1251 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
1252 BIT(IIO_CHAN_INFO_INT_TIME),
1253 .info_mask_separate_available = BIT(IIO_CHAN_INFO_INT_TIME),
1254 .ext_info = vcnl4000_ext_info,
1255 .event_spec = vcnl4040_event_spec,
1256 .num_event_specs = ARRAY_SIZE(vcnl4040_event_spec),
1260 static const struct iio_info vcnl4000_info = {
1261 .read_raw = vcnl4000_read_raw,
1264 static const struct iio_info vcnl4010_info = {
1265 .read_raw = vcnl4010_read_raw,
1266 .read_avail = vcnl4010_read_avail,
1267 .write_raw = vcnl4010_write_raw,
1268 .read_event_value = vcnl4010_read_event,
1269 .write_event_value = vcnl4010_write_event,
1270 .read_event_config = vcnl4010_read_event_config,
1271 .write_event_config = vcnl4010_write_event_config,
1274 static const struct iio_info vcnl4040_info = {
1275 .read_raw = vcnl4000_read_raw,
1276 .write_raw = vcnl4040_write_raw,
1277 .read_event_value = vcnl4040_read_event,
1278 .write_event_value = vcnl4040_write_event,
1279 .read_event_config = vcnl4040_read_event_config,
1280 .write_event_config = vcnl4040_write_event_config,
1281 .read_avail = vcnl4040_read_avail,
1284 static const struct vcnl4000_chip_spec vcnl4000_chip_spec_cfg[] = {
1287 .init = vcnl4000_init,
1288 .measure_light = vcnl4000_measure_light,
1289 .measure_proximity = vcnl4000_measure_proximity,
1290 .set_power_state = vcnl4000_set_power_state,
1291 .channels = vcnl4000_channels,
1292 .num_channels = ARRAY_SIZE(vcnl4000_channels),
1293 .info = &vcnl4000_info,
1296 .prod = "VCNL4010/4020",
1297 .init = vcnl4000_init,
1298 .measure_light = vcnl4000_measure_light,
1299 .measure_proximity = vcnl4000_measure_proximity,
1300 .set_power_state = vcnl4000_set_power_state,
1301 .channels = vcnl4010_channels,
1302 .num_channels = ARRAY_SIZE(vcnl4010_channels),
1303 .info = &vcnl4010_info,
1304 .irq_thread = vcnl4010_irq_thread,
1305 .trig_buffer_func = vcnl4010_trigger_handler,
1306 .buffer_setup_ops = &vcnl4010_buffer_ops,
1310 .init = vcnl4200_init,
1311 .measure_light = vcnl4200_measure_light,
1312 .measure_proximity = vcnl4200_measure_proximity,
1313 .set_power_state = vcnl4200_set_power_state,
1314 .channels = vcnl4040_channels,
1315 .num_channels = ARRAY_SIZE(vcnl4040_channels),
1316 .info = &vcnl4040_info,
1317 .irq_thread = vcnl4040_irq_thread,
1321 .init = vcnl4200_init,
1322 .measure_light = vcnl4200_measure_light,
1323 .measure_proximity = vcnl4200_measure_proximity,
1324 .set_power_state = vcnl4200_set_power_state,
1325 .channels = vcnl4000_channels,
1326 .num_channels = ARRAY_SIZE(vcnl4000_channels),
1327 .info = &vcnl4000_info,
1331 static const struct iio_trigger_ops vcnl4010_trigger_ops = {
1332 .validate_device = iio_trigger_validate_own_device,
1335 static int vcnl4010_probe_trigger(struct iio_dev *indio_dev)
1337 struct vcnl4000_data *data = iio_priv(indio_dev);
1338 struct i2c_client *client = data->client;
1339 struct iio_trigger *trigger;
1341 trigger = devm_iio_trigger_alloc(&client->dev, "%s-dev%d",
1343 iio_device_id(indio_dev));
1347 trigger->ops = &vcnl4010_trigger_ops;
1348 iio_trigger_set_drvdata(trigger, indio_dev);
1350 return devm_iio_trigger_register(&client->dev, trigger);
1353 static int vcnl4000_probe(struct i2c_client *client)
1355 const struct i2c_device_id *id = i2c_client_get_device_id(client);
1356 struct vcnl4000_data *data;
1357 struct iio_dev *indio_dev;
1360 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
1364 data = iio_priv(indio_dev);
1365 i2c_set_clientdata(client, indio_dev);
1366 data->client = client;
1367 data->id = id->driver_data;
1368 data->chip_spec = &vcnl4000_chip_spec_cfg[data->id];
1370 ret = data->chip_spec->init(data);
1374 dev_dbg(&client->dev, "%s Ambient light/proximity sensor, Rev: %02x\n",
1375 data->chip_spec->prod, data->rev);
1377 if (device_property_read_u32(&client->dev, "proximity-near-level",
1379 data->near_level = 0;
1381 indio_dev->info = data->chip_spec->info;
1382 indio_dev->channels = data->chip_spec->channels;
1383 indio_dev->num_channels = data->chip_spec->num_channels;
1384 indio_dev->name = VCNL4000_DRV_NAME;
1385 indio_dev->modes = INDIO_DIRECT_MODE;
1387 if (data->chip_spec->trig_buffer_func &&
1388 data->chip_spec->buffer_setup_ops) {
1389 ret = devm_iio_triggered_buffer_setup(&client->dev, indio_dev,
1391 data->chip_spec->trig_buffer_func,
1392 data->chip_spec->buffer_setup_ops);
1394 dev_err(&client->dev,
1395 "unable to setup iio triggered buffer\n");
1400 if (client->irq && data->chip_spec->irq_thread) {
1401 ret = devm_request_threaded_irq(&client->dev, client->irq,
1402 NULL, data->chip_spec->irq_thread,
1403 IRQF_TRIGGER_FALLING |
1408 dev_err(&client->dev, "irq request failed\n");
1412 ret = vcnl4010_probe_trigger(indio_dev);
1417 ret = pm_runtime_set_active(&client->dev);
1421 ret = iio_device_register(indio_dev);
1425 pm_runtime_enable(&client->dev);
1426 pm_runtime_set_autosuspend_delay(&client->dev, VCNL4000_SLEEP_DELAY_MS);
1427 pm_runtime_use_autosuspend(&client->dev);
1431 data->chip_spec->set_power_state(data, false);
1435 static const struct of_device_id vcnl_4000_of_match[] = {
1437 .compatible = "vishay,vcnl4000",
1438 .data = (void *)VCNL4000,
1441 .compatible = "vishay,vcnl4010",
1442 .data = (void *)VCNL4010,
1445 .compatible = "vishay,vcnl4020",
1446 .data = (void *)VCNL4010,
1449 .compatible = "vishay,vcnl4040",
1450 .data = (void *)VCNL4040,
1453 .compatible = "vishay,vcnl4200",
1454 .data = (void *)VCNL4200,
1458 MODULE_DEVICE_TABLE(of, vcnl_4000_of_match);
1460 static void vcnl4000_remove(struct i2c_client *client)
1462 struct iio_dev *indio_dev = i2c_get_clientdata(client);
1463 struct vcnl4000_data *data = iio_priv(indio_dev);
1466 pm_runtime_dont_use_autosuspend(&client->dev);
1467 pm_runtime_disable(&client->dev);
1468 iio_device_unregister(indio_dev);
1469 pm_runtime_set_suspended(&client->dev);
1471 ret = data->chip_spec->set_power_state(data, false);
1473 dev_warn(&client->dev, "Failed to power down (%pe)\n",
1477 static int vcnl4000_runtime_suspend(struct device *dev)
1479 struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
1480 struct vcnl4000_data *data = iio_priv(indio_dev);
1482 return data->chip_spec->set_power_state(data, false);
1485 static int vcnl4000_runtime_resume(struct device *dev)
1487 struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
1488 struct vcnl4000_data *data = iio_priv(indio_dev);
1490 return data->chip_spec->set_power_state(data, true);
1493 static DEFINE_RUNTIME_DEV_PM_OPS(vcnl4000_pm_ops, vcnl4000_runtime_suspend,
1494 vcnl4000_runtime_resume, NULL);
1496 static struct i2c_driver vcnl4000_driver = {
1498 .name = VCNL4000_DRV_NAME,
1499 .pm = pm_ptr(&vcnl4000_pm_ops),
1500 .of_match_table = vcnl_4000_of_match,
1502 .probe_new = vcnl4000_probe,
1503 .id_table = vcnl4000_id,
1504 .remove = vcnl4000_remove,
1507 module_i2c_driver(vcnl4000_driver);
1509 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
1510 MODULE_AUTHOR("Mathieu Othacehe <m.othacehe@gmail.com>");
1511 MODULE_DESCRIPTION("Vishay VCNL4000 proximity/ambient light sensor driver");
1512 MODULE_LICENSE("GPL");