1 // SPDX-License-Identifier: GPL-2.0+
3 * apds9960.c - Support for Avago APDS9960 gesture/RGB/ALS/proximity sensor
5 * Copyright (C) 2015, 2018
8 * TODO: gesture + proximity calib offsets
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/interrupt.h>
14 #include <linux/delay.h>
15 #include <linux/mutex.h>
16 #include <linux/err.h>
17 #include <linux/irq.h>
18 #include <linux/gpio.h>
19 #include <linux/i2c.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/regmap.h>
22 #include <linux/iio/iio.h>
23 #include <linux/iio/buffer.h>
24 #include <linux/iio/events.h>
25 #include <linux/iio/kfifo_buf.h>
26 #include <linux/iio/sysfs.h>
27 #include <linux/of_gpio.h>
29 #define APDS9960_REGMAP_NAME "apds9960_regmap"
30 #define APDS9960_DRV_NAME "apds9960"
32 #define APDS9960_REG_RAM_START 0x00
33 #define APDS9960_REG_RAM_END 0x7f
35 #define APDS9960_REG_ENABLE 0x80
36 #define APDS9960_REG_ATIME 0x81
37 #define APDS9960_REG_WTIME 0x83
39 #define APDS9960_REG_AILTL 0x84
40 #define APDS9960_REG_AILTH 0x85
41 #define APDS9960_REG_AIHTL 0x86
42 #define APDS9960_REG_AIHTH 0x87
44 #define APDS9960_REG_PILT 0x89
45 #define APDS9960_REG_PIHT 0x8b
46 #define APDS9960_REG_PERS 0x8c
48 #define APDS9960_REG_CONFIG_1 0x8d
49 #define APDS9960_REG_PPULSE 0x8e
51 #define APDS9960_REG_CONTROL 0x8f
52 #define APDS9960_REG_CONTROL_AGAIN_MASK 0x03
53 #define APDS9960_REG_CONTROL_PGAIN_MASK 0x0c
54 #define APDS9960_REG_CONTROL_AGAIN_MASK_SHIFT 0
55 #define APDS9960_REG_CONTROL_PGAIN_MASK_SHIFT 2
57 #define APDS9960_REG_CONFIG_2 0x90
58 #define APDS9960_REG_CONFIG_2_GGAIN_MASK 0x60
59 #define APDS9960_REG_CONFIG_2_GGAIN_MASK_SHIFT 5
61 #define APDS9960_REG_ID 0x92
63 #define APDS9960_REG_STATUS 0x93
64 #define APDS9960_REG_STATUS_PS_INT BIT(5)
65 #define APDS9960_REG_STATUS_ALS_INT BIT(4)
66 #define APDS9960_REG_STATUS_GINT BIT(2)
68 #define APDS9960_REG_PDATA 0x9c
69 #define APDS9960_REG_POFFSET_UR 0x9d
70 #define APDS9960_REG_POFFSET_DL 0x9e
71 #define APDS9960_REG_CONFIG_3 0x9f
73 #define APDS9960_REG_GPENTH 0xa0
74 #define APDS9960_REG_GEXTH 0xa1
76 #define APDS9960_REG_GCONF_1 0xa2
77 #define APDS9960_REG_GCONF_1_GFIFO_THRES_MASK 0xc0
78 #define APDS9960_REG_GCONF_1_GFIFO_THRES_MASK_SHIFT 6
80 #define APDS9960_REG_GCONF_2 0xa3
81 #define APDS9960_REG_GOFFSET_U 0xa4
82 #define APDS9960_REG_GOFFSET_D 0xa5
83 #define APDS9960_REG_GPULSE 0xa6
84 #define APDS9960_REG_GOFFSET_L 0xa7
85 #define APDS9960_REG_GOFFSET_R 0xa9
86 #define APDS9960_REG_GCONF_3 0xaa
88 #define APDS9960_REG_GCONF_4 0xab
89 #define APDS9960_REG_GFLVL 0xae
90 #define APDS9960_REG_GSTATUS 0xaf
92 #define APDS9960_REG_IFORCE 0xe4
93 #define APDS9960_REG_PICLEAR 0xe5
94 #define APDS9960_REG_CICLEAR 0xe6
95 #define APDS9960_REG_AICLEAR 0xe7
97 #define APDS9960_DEFAULT_PERS 0x33
98 #define APDS9960_DEFAULT_GPENTH 0x50
99 #define APDS9960_DEFAULT_GEXTH 0x40
101 #define APDS9960_MAX_PXS_THRES_VAL 255
102 #define APDS9960_MAX_ALS_THRES_VAL 0xffff
103 #define APDS9960_MAX_INT_TIME_IN_US 1000000
105 enum apds9960_als_channel_idx {
106 IDX_ALS_CLEAR, IDX_ALS_RED, IDX_ALS_GREEN, IDX_ALS_BLUE,
109 #define APDS9960_REG_ALS_BASE 0x94
110 #define APDS9960_REG_ALS_CHANNEL(_colour) \
111 (APDS9960_REG_ALS_BASE + (IDX_ALS_##_colour * 2))
113 enum apds9960_gesture_channel_idx {
114 IDX_DIR_UP, IDX_DIR_DOWN, IDX_DIR_LEFT, IDX_DIR_RIGHT,
117 #define APDS9960_REG_GFIFO_BASE 0xfc
118 #define APDS9960_REG_GFIFO_DIR(_dir) \
119 (APDS9960_REG_GFIFO_BASE + IDX_DIR_##_dir)
121 struct apds9960_data {
122 struct i2c_client *client;
123 struct iio_dev *indio_dev;
127 struct regmap *regmap;
128 struct regmap_field *reg_int_als;
129 struct regmap_field *reg_int_ges;
130 struct regmap_field *reg_int_pxs;
132 struct regmap_field *reg_enable_als;
133 struct regmap_field *reg_enable_ges;
134 struct regmap_field *reg_enable_pxs;
139 int gesture_mode_running;
145 /* integration time value in us */
149 u8 buffer[4]; /* 4 8-bit channels */
152 static const struct reg_default apds9960_reg_defaults[] = {
153 /* Default ALS integration time = 2.48ms */
154 { APDS9960_REG_ATIME, 0xff },
157 static const struct regmap_range apds9960_volatile_ranges[] = {
158 regmap_reg_range(APDS9960_REG_STATUS,
160 regmap_reg_range(APDS9960_REG_GFLVL,
161 APDS9960_REG_GSTATUS),
162 regmap_reg_range(APDS9960_REG_GFIFO_DIR(UP),
163 APDS9960_REG_GFIFO_DIR(RIGHT)),
164 regmap_reg_range(APDS9960_REG_IFORCE,
165 APDS9960_REG_AICLEAR),
168 static const struct regmap_access_table apds9960_volatile_table = {
169 .yes_ranges = apds9960_volatile_ranges,
170 .n_yes_ranges = ARRAY_SIZE(apds9960_volatile_ranges),
173 static const struct regmap_range apds9960_precious_ranges[] = {
174 regmap_reg_range(APDS9960_REG_RAM_START, APDS9960_REG_RAM_END),
177 static const struct regmap_access_table apds9960_precious_table = {
178 .yes_ranges = apds9960_precious_ranges,
179 .n_yes_ranges = ARRAY_SIZE(apds9960_precious_ranges),
182 static const struct regmap_range apds9960_readable_ranges[] = {
183 regmap_reg_range(APDS9960_REG_ENABLE,
184 APDS9960_REG_GSTATUS),
185 regmap_reg_range(APDS9960_REG_GFIFO_DIR(UP),
186 APDS9960_REG_GFIFO_DIR(RIGHT)),
189 static const struct regmap_access_table apds9960_readable_table = {
190 .yes_ranges = apds9960_readable_ranges,
191 .n_yes_ranges = ARRAY_SIZE(apds9960_readable_ranges),
194 static const struct regmap_range apds9960_writeable_ranges[] = {
195 regmap_reg_range(APDS9960_REG_ENABLE, APDS9960_REG_CONFIG_2),
196 regmap_reg_range(APDS9960_REG_POFFSET_UR, APDS9960_REG_GCONF_4),
197 regmap_reg_range(APDS9960_REG_IFORCE, APDS9960_REG_AICLEAR),
200 static const struct regmap_access_table apds9960_writeable_table = {
201 .yes_ranges = apds9960_writeable_ranges,
202 .n_yes_ranges = ARRAY_SIZE(apds9960_writeable_ranges),
205 static const struct regmap_config apds9960_regmap_config = {
206 .name = APDS9960_REGMAP_NAME,
211 .volatile_table = &apds9960_volatile_table,
212 .precious_table = &apds9960_precious_table,
213 .rd_table = &apds9960_readable_table,
214 .wr_table = &apds9960_writeable_table,
216 .reg_defaults = apds9960_reg_defaults,
217 .num_reg_defaults = ARRAY_SIZE(apds9960_reg_defaults),
218 .max_register = APDS9960_REG_GFIFO_DIR(RIGHT),
219 .cache_type = REGCACHE_RBTREE,
222 static const struct iio_event_spec apds9960_pxs_event_spec[] = {
224 .type = IIO_EV_TYPE_THRESH,
225 .dir = IIO_EV_DIR_RISING,
226 .mask_separate = BIT(IIO_EV_INFO_VALUE) |
227 BIT(IIO_EV_INFO_ENABLE),
230 .type = IIO_EV_TYPE_THRESH,
231 .dir = IIO_EV_DIR_FALLING,
232 .mask_separate = BIT(IIO_EV_INFO_VALUE) |
233 BIT(IIO_EV_INFO_ENABLE),
237 static const struct iio_event_spec apds9960_als_event_spec[] = {
239 .type = IIO_EV_TYPE_THRESH,
240 .dir = IIO_EV_DIR_RISING,
241 .mask_separate = BIT(IIO_EV_INFO_VALUE) |
242 BIT(IIO_EV_INFO_ENABLE),
245 .type = IIO_EV_TYPE_THRESH,
246 .dir = IIO_EV_DIR_FALLING,
247 .mask_separate = BIT(IIO_EV_INFO_VALUE) |
248 BIT(IIO_EV_INFO_ENABLE),
252 #define APDS9960_GESTURE_CHANNEL(_dir, _si) { \
253 .type = IIO_PROXIMITY, \
254 .channel = _si + 1, \
264 #define APDS9960_INTENSITY_CHANNEL(_colour) { \
265 .type = IIO_INTENSITY, \
266 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
267 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) | \
268 BIT(IIO_CHAN_INFO_INT_TIME), \
269 .channel2 = IIO_MOD_LIGHT_##_colour, \
270 .address = APDS9960_REG_ALS_CHANNEL(_colour), \
275 static const unsigned long apds9960_scan_masks[] = {0xf, 0};
277 static const struct iio_chan_spec apds9960_channels[] = {
279 .type = IIO_PROXIMITY,
280 .address = APDS9960_REG_PDATA,
281 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
282 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
287 .event_spec = apds9960_pxs_event_spec,
288 .num_event_specs = ARRAY_SIZE(apds9960_pxs_event_spec),
291 APDS9960_GESTURE_CHANNEL(UP, 0),
292 APDS9960_GESTURE_CHANNEL(DOWN, 1),
293 APDS9960_GESTURE_CHANNEL(LEFT, 2),
294 APDS9960_GESTURE_CHANNEL(RIGHT, 3),
297 .type = IIO_INTENSITY,
298 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
299 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) |
300 BIT(IIO_CHAN_INFO_INT_TIME),
301 .channel2 = IIO_MOD_LIGHT_CLEAR,
302 .address = APDS9960_REG_ALS_CHANNEL(CLEAR),
306 .event_spec = apds9960_als_event_spec,
307 .num_event_specs = ARRAY_SIZE(apds9960_als_event_spec),
310 APDS9960_INTENSITY_CHANNEL(RED),
311 APDS9960_INTENSITY_CHANNEL(GREEN),
312 APDS9960_INTENSITY_CHANNEL(BLUE),
315 /* integration time in us */
316 static const int apds9960_int_time[][2] = {
324 static const int apds9960_pxs_gain_map[] = {1, 2, 4, 8};
325 static const int apds9960_als_gain_map[] = {1, 4, 16, 64};
327 static IIO_CONST_ATTR(proximity_scale_available, "1 2 4 8");
328 static IIO_CONST_ATTR(intensity_scale_available, "1 4 16 64");
329 static IIO_CONST_ATTR_INT_TIME_AVAIL("0.028 0.1 0.2 0.7");
331 static struct attribute *apds9960_attributes[] = {
332 &iio_const_attr_proximity_scale_available.dev_attr.attr,
333 &iio_const_attr_intensity_scale_available.dev_attr.attr,
334 &iio_const_attr_integration_time_available.dev_attr.attr,
338 static const struct attribute_group apds9960_attribute_group = {
339 .attrs = apds9960_attributes,
342 static const struct reg_field apds9960_reg_field_int_als =
343 REG_FIELD(APDS9960_REG_ENABLE, 4, 4);
345 static const struct reg_field apds9960_reg_field_int_ges =
346 REG_FIELD(APDS9960_REG_GCONF_4, 1, 1);
348 static const struct reg_field apds9960_reg_field_int_pxs =
349 REG_FIELD(APDS9960_REG_ENABLE, 5, 5);
351 static const struct reg_field apds9960_reg_field_enable_als =
352 REG_FIELD(APDS9960_REG_ENABLE, 1, 1);
354 static const struct reg_field apds9960_reg_field_enable_ges =
355 REG_FIELD(APDS9960_REG_ENABLE, 6, 6);
357 static const struct reg_field apds9960_reg_field_enable_pxs =
358 REG_FIELD(APDS9960_REG_ENABLE, 2, 2);
360 static int apds9960_set_it_time(struct apds9960_data *data, int val2)
365 for (idx = 0; idx < ARRAY_SIZE(apds9960_int_time); idx++) {
366 if (apds9960_int_time[idx][0] == val2) {
367 mutex_lock(&data->lock);
368 ret = regmap_write(data->regmap, APDS9960_REG_ATIME,
369 apds9960_int_time[idx][1]);
371 data->als_adc_int_us = val2;
372 mutex_unlock(&data->lock);
380 static int apds9960_set_pxs_gain(struct apds9960_data *data, int val)
385 for (idx = 0; idx < ARRAY_SIZE(apds9960_pxs_gain_map); idx++) {
386 if (apds9960_pxs_gain_map[idx] == val) {
387 /* pxs + gesture gains are mirrored */
388 mutex_lock(&data->lock);
389 ret = regmap_update_bits(data->regmap,
390 APDS9960_REG_CONTROL,
391 APDS9960_REG_CONTROL_PGAIN_MASK,
392 idx << APDS9960_REG_CONTROL_PGAIN_MASK_SHIFT);
394 mutex_unlock(&data->lock);
398 ret = regmap_update_bits(data->regmap,
399 APDS9960_REG_CONFIG_2,
400 APDS9960_REG_CONFIG_2_GGAIN_MASK,
401 idx << APDS9960_REG_CONFIG_2_GGAIN_MASK_SHIFT);
403 data->pxs_gain = idx;
404 mutex_unlock(&data->lock);
412 static int apds9960_set_als_gain(struct apds9960_data *data, int val)
417 for (idx = 0; idx < ARRAY_SIZE(apds9960_als_gain_map); idx++) {
418 if (apds9960_als_gain_map[idx] == val) {
419 mutex_lock(&data->lock);
420 ret = regmap_update_bits(data->regmap,
421 APDS9960_REG_CONTROL,
422 APDS9960_REG_CONTROL_AGAIN_MASK, idx);
424 data->als_gain = idx;
425 mutex_unlock(&data->lock);
434 static int apds9960_set_power_state(struct apds9960_data *data, bool on)
436 struct device *dev = &data->client->dev;
439 mutex_lock(&data->lock);
444 suspended = pm_runtime_suspended(dev);
445 ret = pm_runtime_get_sync(dev);
447 /* Allow one integration cycle before allowing a reading */
449 usleep_range(data->als_adc_int_us,
450 APDS9960_MAX_INT_TIME_IN_US);
452 pm_runtime_mark_last_busy(dev);
453 ret = pm_runtime_put_autosuspend(dev);
456 mutex_unlock(&data->lock);
461 static int apds9960_set_power_state(struct apds9960_data *data, bool on)
467 static int apds9960_read_raw(struct iio_dev *indio_dev,
468 struct iio_chan_spec const *chan,
469 int *val, int *val2, long mask)
471 struct apds9960_data *data = iio_priv(indio_dev);
475 if (data->gesture_mode_running)
479 case IIO_CHAN_INFO_RAW:
480 apds9960_set_power_state(data, true);
481 switch (chan->type) {
483 ret = regmap_read(data->regmap, chan->address, val);
488 ret = regmap_bulk_read(data->regmap, chan->address,
492 *val = le16_to_cpu(buf);
498 apds9960_set_power_state(data, false);
500 case IIO_CHAN_INFO_INT_TIME:
501 /* RGB + ALS sensors only have integration time */
502 mutex_lock(&data->lock);
503 switch (chan->type) {
506 *val2 = data->als_adc_int_us;
507 ret = IIO_VAL_INT_PLUS_MICRO;
512 mutex_unlock(&data->lock);
514 case IIO_CHAN_INFO_SCALE:
515 mutex_lock(&data->lock);
516 switch (chan->type) {
518 *val = apds9960_pxs_gain_map[data->pxs_gain];
522 *val = apds9960_als_gain_map[data->als_gain];
528 mutex_unlock(&data->lock);
535 static int apds9960_write_raw(struct iio_dev *indio_dev,
536 struct iio_chan_spec const *chan,
537 int val, int val2, long mask)
539 struct apds9960_data *data = iio_priv(indio_dev);
542 case IIO_CHAN_INFO_INT_TIME:
543 /* RGB + ALS sensors only have int time */
544 switch (chan->type) {
548 return apds9960_set_it_time(data, val2);
552 case IIO_CHAN_INFO_SCALE:
555 switch (chan->type) {
557 return apds9960_set_pxs_gain(data, val);
559 return apds9960_set_als_gain(data, val);
570 static inline int apds9960_get_thres_reg(const struct iio_chan_spec *chan,
571 enum iio_event_direction dir,
575 case IIO_EV_DIR_RISING:
576 switch (chan->type) {
578 *reg = APDS9960_REG_PIHT;
581 *reg = APDS9960_REG_AIHTL;
587 case IIO_EV_DIR_FALLING:
588 switch (chan->type) {
590 *reg = APDS9960_REG_PILT;
593 *reg = APDS9960_REG_AILTL;
606 static int apds9960_read_event(struct iio_dev *indio_dev,
607 const struct iio_chan_spec *chan,
608 enum iio_event_type type,
609 enum iio_event_direction dir,
610 enum iio_event_info info,
616 struct apds9960_data *data = iio_priv(indio_dev);
618 if (info != IIO_EV_INFO_VALUE)
621 ret = apds9960_get_thres_reg(chan, dir, ®);
625 if (chan->type == IIO_PROXIMITY) {
626 ret = regmap_read(data->regmap, reg, val);
629 } else if (chan->type == IIO_INTENSITY) {
630 ret = regmap_bulk_read(data->regmap, reg, &buf, 2);
633 *val = le16_to_cpu(buf);
642 static int apds9960_write_event(struct iio_dev *indio_dev,
643 const struct iio_chan_spec *chan,
644 enum iio_event_type type,
645 enum iio_event_direction dir,
646 enum iio_event_info info,
652 struct apds9960_data *data = iio_priv(indio_dev);
654 if (info != IIO_EV_INFO_VALUE)
657 ret = apds9960_get_thres_reg(chan, dir, ®);
661 if (chan->type == IIO_PROXIMITY) {
662 if (val < 0 || val > APDS9960_MAX_PXS_THRES_VAL)
664 ret = regmap_write(data->regmap, reg, val);
667 } else if (chan->type == IIO_INTENSITY) {
668 if (val < 0 || val > APDS9960_MAX_ALS_THRES_VAL)
670 buf = cpu_to_le16(val);
671 ret = regmap_bulk_write(data->regmap, reg, &buf, 2);
680 static int apds9960_read_event_config(struct iio_dev *indio_dev,
681 const struct iio_chan_spec *chan,
682 enum iio_event_type type,
683 enum iio_event_direction dir)
685 struct apds9960_data *data = iio_priv(indio_dev);
687 switch (chan->type) {
689 return data->pxs_int;
691 return data->als_int;
699 static int apds9960_write_event_config(struct iio_dev *indio_dev,
700 const struct iio_chan_spec *chan,
701 enum iio_event_type type,
702 enum iio_event_direction dir,
705 struct apds9960_data *data = iio_priv(indio_dev);
710 switch (chan->type) {
712 if (data->pxs_int == state)
715 ret = regmap_field_write(data->reg_int_pxs, state);
718 data->pxs_int = state;
719 apds9960_set_power_state(data, state);
722 if (data->als_int == state)
725 ret = regmap_field_write(data->reg_int_als, state);
728 data->als_int = state;
729 apds9960_set_power_state(data, state);
738 static const struct iio_info apds9960_info = {
739 .attrs = &apds9960_attribute_group,
740 .read_raw = apds9960_read_raw,
741 .write_raw = apds9960_write_raw,
742 .read_event_value = apds9960_read_event,
743 .write_event_value = apds9960_write_event,
744 .read_event_config = apds9960_read_event_config,
745 .write_event_config = apds9960_write_event_config,
749 static inline int apds9660_fifo_is_empty(struct apds9960_data *data)
754 ret = regmap_read(data->regmap, APDS9960_REG_GFLVL, &cnt);
761 static void apds9960_read_gesture_fifo(struct apds9960_data *data)
765 mutex_lock(&data->lock);
766 data->gesture_mode_running = 1;
768 while (cnt || (cnt = apds9660_fifo_is_empty(data) > 0)) {
769 ret = regmap_bulk_read(data->regmap, APDS9960_REG_GFIFO_BASE,
775 iio_push_to_buffers(data->indio_dev, data->buffer);
780 data->gesture_mode_running = 0;
781 mutex_unlock(&data->lock);
784 static irqreturn_t apds9960_interrupt_handler(int irq, void *private)
786 struct iio_dev *indio_dev = private;
787 struct apds9960_data *data = iio_priv(indio_dev);
790 ret = regmap_read(data->regmap, APDS9960_REG_STATUS, &status);
792 dev_err(&data->client->dev, "irq status reg read failed\n");
796 if ((status & APDS9960_REG_STATUS_ALS_INT) && data->als_int) {
797 iio_push_event(indio_dev,
798 IIO_UNMOD_EVENT_CODE(IIO_INTENSITY, 0,
801 iio_get_time_ns(indio_dev));
802 regmap_write(data->regmap, APDS9960_REG_CICLEAR, 1);
805 if ((status & APDS9960_REG_STATUS_PS_INT) && data->pxs_int) {
806 iio_push_event(indio_dev,
807 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
810 iio_get_time_ns(indio_dev));
811 regmap_write(data->regmap, APDS9960_REG_PICLEAR, 1);
814 if (status & APDS9960_REG_STATUS_GINT)
815 apds9960_read_gesture_fifo(data);
820 static int apds9960_set_powermode(struct apds9960_data *data, bool state)
822 return regmap_update_bits(data->regmap, APDS9960_REG_ENABLE, 1, state);
825 static int apds9960_buffer_postenable(struct iio_dev *indio_dev)
827 struct apds9960_data *data = iio_priv(indio_dev);
830 ret = regmap_field_write(data->reg_int_ges, 1);
834 ret = regmap_field_write(data->reg_enable_ges, 1);
838 pm_runtime_get_sync(&data->client->dev);
843 static int apds9960_buffer_predisable(struct iio_dev *indio_dev)
845 struct apds9960_data *data = iio_priv(indio_dev);
848 ret = regmap_field_write(data->reg_enable_ges, 0);
852 ret = regmap_field_write(data->reg_int_ges, 0);
856 pm_runtime_put_autosuspend(&data->client->dev);
861 static const struct iio_buffer_setup_ops apds9960_buffer_setup_ops = {
862 .postenable = apds9960_buffer_postenable,
863 .predisable = apds9960_buffer_predisable,
866 static int apds9960_regfield_init(struct apds9960_data *data)
868 struct device *dev = &data->client->dev;
869 struct regmap *regmap = data->regmap;
871 data->reg_int_als = devm_regmap_field_alloc(dev, regmap,
872 apds9960_reg_field_int_als);
873 if (IS_ERR(data->reg_int_als)) {
874 dev_err(dev, "INT ALS reg field init failed\n");
875 return PTR_ERR(data->reg_int_als);
878 data->reg_int_ges = devm_regmap_field_alloc(dev, regmap,
879 apds9960_reg_field_int_ges);
880 if (IS_ERR(data->reg_int_ges)) {
881 dev_err(dev, "INT gesture reg field init failed\n");
882 return PTR_ERR(data->reg_int_ges);
885 data->reg_int_pxs = devm_regmap_field_alloc(dev, regmap,
886 apds9960_reg_field_int_pxs);
887 if (IS_ERR(data->reg_int_pxs)) {
888 dev_err(dev, "INT pxs reg field init failed\n");
889 return PTR_ERR(data->reg_int_pxs);
892 data->reg_enable_als = devm_regmap_field_alloc(dev, regmap,
893 apds9960_reg_field_enable_als);
894 if (IS_ERR(data->reg_enable_als)) {
895 dev_err(dev, "Enable ALS reg field init failed\n");
896 return PTR_ERR(data->reg_enable_als);
899 data->reg_enable_ges = devm_regmap_field_alloc(dev, regmap,
900 apds9960_reg_field_enable_ges);
901 if (IS_ERR(data->reg_enable_ges)) {
902 dev_err(dev, "Enable gesture reg field init failed\n");
903 return PTR_ERR(data->reg_enable_ges);
906 data->reg_enable_pxs = devm_regmap_field_alloc(dev, regmap,
907 apds9960_reg_field_enable_pxs);
908 if (IS_ERR(data->reg_enable_pxs)) {
909 dev_err(dev, "Enable PXS reg field init failed\n");
910 return PTR_ERR(data->reg_enable_pxs);
916 static int apds9960_chip_init(struct apds9960_data *data)
920 /* Default IT for ALS of 28 ms */
921 ret = apds9960_set_it_time(data, 28000);
925 /* Ensure gesture interrupt is OFF */
926 ret = regmap_field_write(data->reg_int_ges, 0);
930 /* Disable gesture sensor, since polling is useless from user-space */
931 ret = regmap_field_write(data->reg_enable_ges, 0);
935 /* Ensure proximity interrupt is OFF */
936 ret = regmap_field_write(data->reg_int_pxs, 0);
940 /* Enable proximity sensor for polling */
941 ret = regmap_field_write(data->reg_enable_pxs, 1);
945 /* Ensure ALS interrupt is OFF */
946 ret = regmap_field_write(data->reg_int_als, 0);
950 /* Enable ALS sensor for polling */
951 ret = regmap_field_write(data->reg_enable_als, 1);
955 * When enabled trigger an interrupt after 3 readings
956 * outside threshold for ALS + PXS
958 ret = regmap_write(data->regmap, APDS9960_REG_PERS,
959 APDS9960_DEFAULT_PERS);
964 * Wait for 4 event outside gesture threshold to prevent interrupt
967 ret = regmap_update_bits(data->regmap, APDS9960_REG_GCONF_1,
968 APDS9960_REG_GCONF_1_GFIFO_THRES_MASK,
969 BIT(0) << APDS9960_REG_GCONF_1_GFIFO_THRES_MASK_SHIFT);
973 /* Default ENTER and EXIT thresholds for the GESTURE engine. */
974 ret = regmap_write(data->regmap, APDS9960_REG_GPENTH,
975 APDS9960_DEFAULT_GPENTH);
979 ret = regmap_write(data->regmap, APDS9960_REG_GEXTH,
980 APDS9960_DEFAULT_GEXTH);
984 return apds9960_set_powermode(data, 1);
987 static int apds9960_probe(struct i2c_client *client,
988 const struct i2c_device_id *id)
990 struct apds9960_data *data;
991 struct iio_buffer *buffer;
992 struct iio_dev *indio_dev;
995 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
999 buffer = devm_iio_kfifo_allocate(&client->dev);
1003 iio_device_attach_buffer(indio_dev, buffer);
1005 indio_dev->dev.parent = &client->dev;
1006 indio_dev->info = &apds9960_info;
1007 indio_dev->name = APDS9960_DRV_NAME;
1008 indio_dev->channels = apds9960_channels;
1009 indio_dev->num_channels = ARRAY_SIZE(apds9960_channels);
1010 indio_dev->available_scan_masks = apds9960_scan_masks;
1011 indio_dev->modes = (INDIO_BUFFER_SOFTWARE | INDIO_DIRECT_MODE);
1012 indio_dev->setup_ops = &apds9960_buffer_setup_ops;
1014 data = iio_priv(indio_dev);
1015 i2c_set_clientdata(client, indio_dev);
1017 data->regmap = devm_regmap_init_i2c(client, &apds9960_regmap_config);
1018 if (IS_ERR(data->regmap)) {
1019 dev_err(&client->dev, "regmap initialization failed.\n");
1020 return PTR_ERR(data->regmap);
1023 data->client = client;
1024 data->indio_dev = indio_dev;
1025 mutex_init(&data->lock);
1027 ret = pm_runtime_set_active(&client->dev);
1029 goto error_power_down;
1031 pm_runtime_enable(&client->dev);
1032 pm_runtime_set_autosuspend_delay(&client->dev, 5000);
1033 pm_runtime_use_autosuspend(&client->dev);
1035 apds9960_set_power_state(data, true);
1037 ret = apds9960_regfield_init(data);
1039 goto error_power_down;
1041 ret = apds9960_chip_init(data);
1043 goto error_power_down;
1045 if (client->irq <= 0) {
1046 dev_err(&client->dev, "no valid irq defined\n");
1048 goto error_power_down;
1050 ret = devm_request_threaded_irq(&client->dev, client->irq,
1051 NULL, apds9960_interrupt_handler,
1052 IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
1056 dev_err(&client->dev, "request irq (%d) failed\n", client->irq);
1057 goto error_power_down;
1060 ret = iio_device_register(indio_dev);
1062 goto error_power_down;
1064 apds9960_set_power_state(data, false);
1069 apds9960_set_power_state(data, false);
1074 static int apds9960_remove(struct i2c_client *client)
1076 struct iio_dev *indio_dev = i2c_get_clientdata(client);
1077 struct apds9960_data *data = iio_priv(indio_dev);
1079 iio_device_unregister(indio_dev);
1080 pm_runtime_disable(&client->dev);
1081 pm_runtime_set_suspended(&client->dev);
1082 apds9960_set_powermode(data, 0);
1088 static int apds9960_runtime_suspend(struct device *dev)
1090 struct apds9960_data *data =
1091 iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
1093 return apds9960_set_powermode(data, 0);
1096 static int apds9960_runtime_resume(struct device *dev)
1098 struct apds9960_data *data =
1099 iio_priv(i2c_get_clientdata(to_i2c_client(dev)));
1101 return apds9960_set_powermode(data, 1);
1105 static const struct dev_pm_ops apds9960_pm_ops = {
1106 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
1107 pm_runtime_force_resume)
1108 SET_RUNTIME_PM_OPS(apds9960_runtime_suspend,
1109 apds9960_runtime_resume, NULL)
1112 static const struct i2c_device_id apds9960_id[] = {
1116 MODULE_DEVICE_TABLE(i2c, apds9960_id);
1118 static const struct of_device_id apds9960_of_match[] = {
1119 { .compatible = "avago,apds9960" },
1122 MODULE_DEVICE_TABLE(of, apds9960_of_match);
1124 static struct i2c_driver apds9960_driver = {
1126 .name = APDS9960_DRV_NAME,
1127 .of_match_table = apds9960_of_match,
1128 .pm = &apds9960_pm_ops,
1130 .probe = apds9960_probe,
1131 .remove = apds9960_remove,
1132 .id_table = apds9960_id,
1134 module_i2c_driver(apds9960_driver);
1137 MODULE_DESCRIPTION("ADPS9960 Gesture/RGB/ALS/Proximity sensor");
1138 MODULE_LICENSE("GPL");