1 // SPDX-License-Identifier: GPL-2.0-only
3 * ltr501.c - Support for Lite-On LTR501 ambient light and proximity sensor
5 * Copyright 2014 Peter Meerwald <pmeerw@pmeerw.net>
7 * 7-bit I2C slave address 0x23
9 * TODO: IR LED characteristics
12 #include <linux/module.h>
13 #include <linux/i2c.h>
14 #include <linux/err.h>
15 #include <linux/delay.h>
16 #include <linux/regmap.h>
17 #include <linux/acpi.h>
19 #include <linux/iio/iio.h>
20 #include <linux/iio/events.h>
21 #include <linux/iio/sysfs.h>
22 #include <linux/iio/trigger_consumer.h>
23 #include <linux/iio/buffer.h>
24 #include <linux/iio/triggered_buffer.h>
26 #define LTR501_DRV_NAME "ltr501"
28 #define LTR501_ALS_CONTR 0x80 /* ALS operation mode, SW reset */
29 #define LTR501_PS_CONTR 0x81 /* PS operation mode */
30 #define LTR501_PS_MEAS_RATE 0x84 /* measurement rate*/
31 #define LTR501_ALS_MEAS_RATE 0x85 /* ALS integ time, measurement rate*/
32 #define LTR501_PART_ID 0x86
33 #define LTR501_MANUFAC_ID 0x87
34 #define LTR501_ALS_DATA1 0x88 /* 16-bit, little endian */
35 #define LTR501_ALS_DATA1_UPPER 0x89 /* upper 8 bits of LTR501_ALS_DATA1 */
36 #define LTR501_ALS_DATA0 0x8a /* 16-bit, little endian */
37 #define LTR501_ALS_DATA0_UPPER 0x8b /* upper 8 bits of LTR501_ALS_DATA0 */
38 #define LTR501_ALS_PS_STATUS 0x8c
39 #define LTR501_PS_DATA 0x8d /* 16-bit, little endian */
40 #define LTR501_PS_DATA_UPPER 0x8e /* upper 8 bits of LTR501_PS_DATA */
41 #define LTR501_INTR 0x8f /* output mode, polarity, mode */
42 #define LTR501_PS_THRESH_UP 0x90 /* 11 bit, ps upper threshold */
43 #define LTR501_PS_THRESH_LOW 0x92 /* 11 bit, ps lower threshold */
44 #define LTR501_ALS_THRESH_UP 0x97 /* 16 bit, ALS upper threshold */
45 #define LTR501_ALS_THRESH_LOW 0x99 /* 16 bit, ALS lower threshold */
46 #define LTR501_INTR_PRST 0x9e /* ps thresh, als thresh */
47 #define LTR501_MAX_REG 0x9f
49 #define LTR501_ALS_CONTR_SW_RESET BIT(2)
50 #define LTR501_CONTR_PS_GAIN_MASK (BIT(3) | BIT(2))
51 #define LTR501_CONTR_PS_GAIN_SHIFT 2
52 #define LTR501_CONTR_ALS_GAIN_MASK BIT(3)
53 #define LTR501_CONTR_ACTIVE BIT(1)
55 #define LTR501_STATUS_ALS_INTR BIT(3)
56 #define LTR501_STATUS_ALS_RDY BIT(2)
57 #define LTR501_STATUS_PS_INTR BIT(1)
58 #define LTR501_STATUS_PS_RDY BIT(0)
60 #define LTR501_PS_DATA_MASK 0x7ff
61 #define LTR501_PS_THRESH_MASK 0x7ff
62 #define LTR501_ALS_THRESH_MASK 0xffff
64 #define LTR501_ALS_DEF_PERIOD 500000
65 #define LTR501_PS_DEF_PERIOD 100000
67 #define LTR501_REGMAP_NAME "ltr501_regmap"
69 #define LTR501_LUX_CONV(vis_coeff, vis_data, ir_coeff, ir_data) \
70 ((vis_coeff * vis_data) - (ir_coeff * ir_data))
72 static const int int_time_mapping[] = {100000, 50000, 200000, 400000};
74 static const struct reg_field reg_field_it =
75 REG_FIELD(LTR501_ALS_MEAS_RATE, 3, 4);
76 static const struct reg_field reg_field_als_intr =
77 REG_FIELD(LTR501_INTR, 1, 1);
78 static const struct reg_field reg_field_ps_intr =
79 REG_FIELD(LTR501_INTR, 0, 0);
80 static const struct reg_field reg_field_als_rate =
81 REG_FIELD(LTR501_ALS_MEAS_RATE, 0, 2);
82 static const struct reg_field reg_field_ps_rate =
83 REG_FIELD(LTR501_PS_MEAS_RATE, 0, 3);
84 static const struct reg_field reg_field_als_prst =
85 REG_FIELD(LTR501_INTR_PRST, 0, 3);
86 static const struct reg_field reg_field_ps_prst =
87 REG_FIELD(LTR501_INTR_PRST, 4, 7);
89 struct ltr501_samp_table {
90 int freq_val; /* repetition frequency in micro HZ*/
91 int time_val; /* repetition rate in micro seconds */
94 #define LTR501_RESERVED_GAIN -1
107 static const struct ltr501_gain ltr501_als_gain_tbl[] = {
112 static const struct ltr501_gain ltr559_als_gain_tbl[] = {
117 {LTR501_RESERVED_GAIN, LTR501_RESERVED_GAIN},
118 {LTR501_RESERVED_GAIN, LTR501_RESERVED_GAIN},
123 static const struct ltr501_gain ltr501_ps_gain_tbl[] = {
130 static const struct ltr501_gain ltr559_ps_gain_tbl[] = {
131 {0, 62500}, /* x16 gain */
132 {0, 31250}, /* x32 gain */
133 {0, 15625}, /* bits X1 are for x64 gain */
137 struct ltr501_chip_info {
139 const struct ltr501_gain *als_gain;
140 int als_gain_tbl_size;
141 const struct ltr501_gain *ps_gain;
142 int ps_gain_tbl_size;
146 struct iio_chan_spec const *channels;
147 const int no_channels;
148 const struct iio_info *info;
149 const struct iio_info *info_no_irq;
153 struct i2c_client *client;
154 struct mutex lock_als, lock_ps;
155 struct ltr501_chip_info *chip_info;
156 u8 als_contr, ps_contr;
157 int als_period, ps_period; /* period in micro seconds */
158 struct regmap *regmap;
159 struct regmap_field *reg_it;
160 struct regmap_field *reg_als_intr;
161 struct regmap_field *reg_ps_intr;
162 struct regmap_field *reg_als_rate;
163 struct regmap_field *reg_ps_rate;
164 struct regmap_field *reg_als_prst;
165 struct regmap_field *reg_ps_prst;
168 static const struct ltr501_samp_table ltr501_als_samp_table[] = {
169 {20000000, 50000}, {10000000, 100000},
170 {5000000, 200000}, {2000000, 500000},
171 {1000000, 1000000}, {500000, 2000000},
172 {500000, 2000000}, {500000, 2000000}
175 static const struct ltr501_samp_table ltr501_ps_samp_table[] = {
176 {20000000, 50000}, {14285714, 70000},
177 {10000000, 100000}, {5000000, 200000},
178 {2000000, 500000}, {1000000, 1000000},
179 {500000, 2000000}, {500000, 2000000},
183 static int ltr501_match_samp_freq(const struct ltr501_samp_table *tab,
184 int len, int val, int val2)
188 freq = val * 1000000 + val2;
190 for (i = 0; i < len; i++) {
191 if (tab[i].freq_val == freq)
198 static int ltr501_als_read_samp_freq(const struct ltr501_data *data,
203 ret = regmap_field_read(data->reg_als_rate, &i);
207 if (i < 0 || i >= ARRAY_SIZE(ltr501_als_samp_table))
210 *val = ltr501_als_samp_table[i].freq_val / 1000000;
211 *val2 = ltr501_als_samp_table[i].freq_val % 1000000;
213 return IIO_VAL_INT_PLUS_MICRO;
216 static int ltr501_ps_read_samp_freq(const struct ltr501_data *data,
221 ret = regmap_field_read(data->reg_ps_rate, &i);
225 if (i < 0 || i >= ARRAY_SIZE(ltr501_ps_samp_table))
228 *val = ltr501_ps_samp_table[i].freq_val / 1000000;
229 *val2 = ltr501_ps_samp_table[i].freq_val % 1000000;
231 return IIO_VAL_INT_PLUS_MICRO;
234 static int ltr501_als_write_samp_freq(struct ltr501_data *data,
239 i = ltr501_match_samp_freq(ltr501_als_samp_table,
240 ARRAY_SIZE(ltr501_als_samp_table),
246 mutex_lock(&data->lock_als);
247 ret = regmap_field_write(data->reg_als_rate, i);
248 mutex_unlock(&data->lock_als);
253 static int ltr501_ps_write_samp_freq(struct ltr501_data *data,
258 i = ltr501_match_samp_freq(ltr501_ps_samp_table,
259 ARRAY_SIZE(ltr501_ps_samp_table),
265 mutex_lock(&data->lock_ps);
266 ret = regmap_field_write(data->reg_ps_rate, i);
267 mutex_unlock(&data->lock_ps);
272 static int ltr501_als_read_samp_period(const struct ltr501_data *data, int *val)
276 ret = regmap_field_read(data->reg_als_rate, &i);
280 if (i < 0 || i >= ARRAY_SIZE(ltr501_als_samp_table))
283 *val = ltr501_als_samp_table[i].time_val;
288 static int ltr501_ps_read_samp_period(const struct ltr501_data *data, int *val)
292 ret = regmap_field_read(data->reg_ps_rate, &i);
296 if (i < 0 || i >= ARRAY_SIZE(ltr501_ps_samp_table))
299 *val = ltr501_ps_samp_table[i].time_val;
304 /* IR and visible spectrum coeff's are given in data sheet */
305 static unsigned long ltr501_calculate_lux(u16 vis_data, u16 ir_data)
307 unsigned long ratio, lux;
312 /* multiply numerator by 100 to avoid handling ratio < 1 */
313 ratio = DIV_ROUND_UP(ir_data * 100, ir_data + vis_data);
316 lux = LTR501_LUX_CONV(1774, vis_data, -1105, ir_data);
317 else if (ratio >= 45 && ratio < 64)
318 lux = LTR501_LUX_CONV(3772, vis_data, 1336, ir_data);
319 else if (ratio >= 64 && ratio < 85)
320 lux = LTR501_LUX_CONV(1690, vis_data, 169, ir_data);
327 static int ltr501_drdy(const struct ltr501_data *data, u8 drdy_mask)
333 ret = regmap_read(data->regmap, LTR501_ALS_PS_STATUS, &status);
336 if ((status & drdy_mask) == drdy_mask)
341 dev_err(&data->client->dev, "ltr501_drdy() failed, data not ready\n");
345 static int ltr501_set_it_time(struct ltr501_data *data, int it)
347 int ret, i, index = -1, status;
349 for (i = 0; i < ARRAY_SIZE(int_time_mapping); i++) {
350 if (int_time_mapping[i] == it) {
355 /* Make sure integ time index is valid */
359 ret = regmap_read(data->regmap, LTR501_ALS_CONTR, &status);
363 if (status & LTR501_CONTR_ALS_GAIN_MASK) {
365 * 200 ms and 400 ms integ time can only be
366 * used in dynamic range 1
371 /* 50 ms integ time can only be used in dynamic range 2 */
375 return regmap_field_write(data->reg_it, index);
378 /* read int time in micro seconds */
379 static int ltr501_read_it_time(const struct ltr501_data *data,
384 ret = regmap_field_read(data->reg_it, &index);
388 /* Make sure integ time index is valid */
389 if (index < 0 || index >= ARRAY_SIZE(int_time_mapping))
392 *val2 = int_time_mapping[index];
395 return IIO_VAL_INT_PLUS_MICRO;
398 static int ltr501_read_als(const struct ltr501_data *data, __le16 buf[2])
402 ret = ltr501_drdy(data, LTR501_STATUS_ALS_RDY);
405 /* always read both ALS channels in given order */
406 return regmap_bulk_read(data->regmap, LTR501_ALS_DATA1,
407 buf, 2 * sizeof(__le16));
410 static int ltr501_read_ps(const struct ltr501_data *data)
414 ret = ltr501_drdy(data, LTR501_STATUS_PS_RDY);
418 ret = regmap_bulk_read(data->regmap, LTR501_PS_DATA,
426 static int ltr501_read_intr_prst(const struct ltr501_data *data,
427 enum iio_chan_type type,
430 int ret, samp_period, prst;
434 ret = regmap_field_read(data->reg_als_prst, &prst);
438 ret = ltr501_als_read_samp_period(data, &samp_period);
442 *val2 = samp_period * prst;
443 return IIO_VAL_INT_PLUS_MICRO;
445 ret = regmap_field_read(data->reg_ps_prst, &prst);
449 ret = ltr501_ps_read_samp_period(data, &samp_period);
454 *val2 = samp_period * prst;
455 return IIO_VAL_INT_PLUS_MICRO;
463 static int ltr501_write_intr_prst(struct ltr501_data *data,
464 enum iio_chan_type type,
467 int ret, samp_period, new_val;
468 unsigned long period;
470 if (val < 0 || val2 < 0)
473 /* period in microseconds */
474 period = ((val * 1000000) + val2);
478 ret = ltr501_als_read_samp_period(data, &samp_period);
482 /* period should be atleast equal to sampling period */
483 if (period < samp_period)
486 new_val = DIV_ROUND_UP(period, samp_period);
487 if (new_val < 0 || new_val > 0x0f)
490 mutex_lock(&data->lock_als);
491 ret = regmap_field_write(data->reg_als_prst, new_val);
492 mutex_unlock(&data->lock_als);
494 data->als_period = period;
498 ret = ltr501_ps_read_samp_period(data, &samp_period);
502 /* period should be atleast equal to rate */
503 if (period < samp_period)
506 new_val = DIV_ROUND_UP(period, samp_period);
507 if (new_val < 0 || new_val > 0x0f)
510 mutex_lock(&data->lock_ps);
511 ret = regmap_field_write(data->reg_ps_prst, new_val);
512 mutex_unlock(&data->lock_ps);
514 data->ps_period = period;
524 static const struct iio_event_spec ltr501_als_event_spec[] = {
526 .type = IIO_EV_TYPE_THRESH,
527 .dir = IIO_EV_DIR_RISING,
528 .mask_separate = BIT(IIO_EV_INFO_VALUE),
530 .type = IIO_EV_TYPE_THRESH,
531 .dir = IIO_EV_DIR_FALLING,
532 .mask_separate = BIT(IIO_EV_INFO_VALUE),
534 .type = IIO_EV_TYPE_THRESH,
535 .dir = IIO_EV_DIR_EITHER,
536 .mask_separate = BIT(IIO_EV_INFO_ENABLE) |
537 BIT(IIO_EV_INFO_PERIOD),
542 static const struct iio_event_spec ltr501_pxs_event_spec[] = {
544 .type = IIO_EV_TYPE_THRESH,
545 .dir = IIO_EV_DIR_RISING,
546 .mask_separate = BIT(IIO_EV_INFO_VALUE),
548 .type = IIO_EV_TYPE_THRESH,
549 .dir = IIO_EV_DIR_FALLING,
550 .mask_separate = BIT(IIO_EV_INFO_VALUE),
552 .type = IIO_EV_TYPE_THRESH,
553 .dir = IIO_EV_DIR_EITHER,
554 .mask_separate = BIT(IIO_EV_INFO_ENABLE) |
555 BIT(IIO_EV_INFO_PERIOD),
559 #define LTR501_INTENSITY_CHANNEL(_idx, _addr, _mod, _shared, \
560 _evspec, _evsize) { \
561 .type = IIO_INTENSITY, \
563 .address = (_addr), \
564 .channel2 = (_mod), \
565 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
566 .info_mask_shared_by_type = (_shared), \
567 .scan_index = (_idx), \
572 .endianness = IIO_CPU, \
574 .event_spec = _evspec,\
575 .num_event_specs = _evsize,\
578 #define LTR501_LIGHT_CHANNEL() { \
580 .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED), \
584 static const struct iio_chan_spec ltr501_channels[] = {
585 LTR501_LIGHT_CHANNEL(),
586 LTR501_INTENSITY_CHANNEL(0, LTR501_ALS_DATA0, IIO_MOD_LIGHT_BOTH, 0,
587 ltr501_als_event_spec,
588 ARRAY_SIZE(ltr501_als_event_spec)),
589 LTR501_INTENSITY_CHANNEL(1, LTR501_ALS_DATA1, IIO_MOD_LIGHT_IR,
590 BIT(IIO_CHAN_INFO_SCALE) |
591 BIT(IIO_CHAN_INFO_INT_TIME) |
592 BIT(IIO_CHAN_INFO_SAMP_FREQ),
595 .type = IIO_PROXIMITY,
596 .address = LTR501_PS_DATA,
597 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
598 BIT(IIO_CHAN_INFO_SCALE),
604 .endianness = IIO_CPU,
606 .event_spec = ltr501_pxs_event_spec,
607 .num_event_specs = ARRAY_SIZE(ltr501_pxs_event_spec),
609 IIO_CHAN_SOFT_TIMESTAMP(3),
612 static const struct iio_chan_spec ltr301_channels[] = {
613 LTR501_LIGHT_CHANNEL(),
614 LTR501_INTENSITY_CHANNEL(0, LTR501_ALS_DATA0, IIO_MOD_LIGHT_BOTH, 0,
615 ltr501_als_event_spec,
616 ARRAY_SIZE(ltr501_als_event_spec)),
617 LTR501_INTENSITY_CHANNEL(1, LTR501_ALS_DATA1, IIO_MOD_LIGHT_IR,
618 BIT(IIO_CHAN_INFO_SCALE) |
619 BIT(IIO_CHAN_INFO_INT_TIME) |
620 BIT(IIO_CHAN_INFO_SAMP_FREQ),
622 IIO_CHAN_SOFT_TIMESTAMP(2),
625 static int ltr501_read_raw(struct iio_dev *indio_dev,
626 struct iio_chan_spec const *chan,
627 int *val, int *val2, long mask)
629 struct ltr501_data *data = iio_priv(indio_dev);
634 case IIO_CHAN_INFO_PROCESSED:
635 switch (chan->type) {
637 ret = iio_device_claim_direct_mode(indio_dev);
641 mutex_lock(&data->lock_als);
642 ret = ltr501_read_als(data, buf);
643 mutex_unlock(&data->lock_als);
644 iio_device_release_direct_mode(indio_dev);
647 *val = ltr501_calculate_lux(le16_to_cpu(buf[1]),
648 le16_to_cpu(buf[0]));
653 case IIO_CHAN_INFO_RAW:
654 ret = iio_device_claim_direct_mode(indio_dev);
658 switch (chan->type) {
660 mutex_lock(&data->lock_als);
661 ret = ltr501_read_als(data, buf);
662 mutex_unlock(&data->lock_als);
665 *val = le16_to_cpu(chan->address == LTR501_ALS_DATA1 ?
670 mutex_lock(&data->lock_ps);
671 ret = ltr501_read_ps(data);
672 mutex_unlock(&data->lock_ps);
675 *val = ret & LTR501_PS_DATA_MASK;
683 iio_device_release_direct_mode(indio_dev);
686 case IIO_CHAN_INFO_SCALE:
687 switch (chan->type) {
689 i = (data->als_contr & data->chip_info->als_gain_mask)
690 >> data->chip_info->als_gain_shift;
691 *val = data->chip_info->als_gain[i].scale;
692 *val2 = data->chip_info->als_gain[i].uscale;
693 return IIO_VAL_INT_PLUS_MICRO;
695 i = (data->ps_contr & LTR501_CONTR_PS_GAIN_MASK) >>
696 LTR501_CONTR_PS_GAIN_SHIFT;
697 *val = data->chip_info->ps_gain[i].scale;
698 *val2 = data->chip_info->ps_gain[i].uscale;
699 return IIO_VAL_INT_PLUS_MICRO;
703 case IIO_CHAN_INFO_INT_TIME:
704 switch (chan->type) {
706 return ltr501_read_it_time(data, val, val2);
710 case IIO_CHAN_INFO_SAMP_FREQ:
711 switch (chan->type) {
713 return ltr501_als_read_samp_freq(data, val, val2);
715 return ltr501_ps_read_samp_freq(data, val, val2);
723 static int ltr501_get_gain_index(const struct ltr501_gain *gain, int size,
728 for (i = 0; i < size; i++)
729 if (val == gain[i].scale && val2 == gain[i].uscale)
735 static int ltr501_write_raw(struct iio_dev *indio_dev,
736 struct iio_chan_spec const *chan,
737 int val, int val2, long mask)
739 struct ltr501_data *data = iio_priv(indio_dev);
740 int i, ret, freq_val, freq_val2;
741 struct ltr501_chip_info *info = data->chip_info;
743 ret = iio_device_claim_direct_mode(indio_dev);
748 case IIO_CHAN_INFO_SCALE:
749 switch (chan->type) {
751 i = ltr501_get_gain_index(info->als_gain,
752 info->als_gain_tbl_size,
759 data->als_contr &= ~info->als_gain_mask;
760 data->als_contr |= i << info->als_gain_shift;
762 ret = regmap_write(data->regmap, LTR501_ALS_CONTR,
766 i = ltr501_get_gain_index(info->ps_gain,
767 info->ps_gain_tbl_size,
773 data->ps_contr &= ~LTR501_CONTR_PS_GAIN_MASK;
774 data->ps_contr |= i << LTR501_CONTR_PS_GAIN_SHIFT;
776 ret = regmap_write(data->regmap, LTR501_PS_CONTR,
785 case IIO_CHAN_INFO_INT_TIME:
786 switch (chan->type) {
792 mutex_lock(&data->lock_als);
793 ret = ltr501_set_it_time(data, val2);
794 mutex_unlock(&data->lock_als);
802 case IIO_CHAN_INFO_SAMP_FREQ:
803 switch (chan->type) {
805 ret = ltr501_als_read_samp_freq(data, &freq_val,
810 ret = ltr501_als_write_samp_freq(data, val, val2);
814 /* update persistence count when changing frequency */
815 ret = ltr501_write_intr_prst(data, chan->type,
816 0, data->als_period);
819 ret = ltr501_als_write_samp_freq(data, freq_val,
823 ret = ltr501_ps_read_samp_freq(data, &freq_val,
828 ret = ltr501_ps_write_samp_freq(data, val, val2);
832 /* update persistence count when changing frequency */
833 ret = ltr501_write_intr_prst(data, chan->type,
837 ret = ltr501_ps_write_samp_freq(data, freq_val,
851 iio_device_release_direct_mode(indio_dev);
855 static int ltr501_read_thresh(const struct iio_dev *indio_dev,
856 const struct iio_chan_spec *chan,
857 enum iio_event_type type,
858 enum iio_event_direction dir,
859 enum iio_event_info info,
862 const struct ltr501_data *data = iio_priv(indio_dev);
863 int ret, thresh_data;
865 switch (chan->type) {
868 case IIO_EV_DIR_RISING:
869 ret = regmap_bulk_read(data->regmap,
870 LTR501_ALS_THRESH_UP,
874 *val = thresh_data & LTR501_ALS_THRESH_MASK;
876 case IIO_EV_DIR_FALLING:
877 ret = regmap_bulk_read(data->regmap,
878 LTR501_ALS_THRESH_LOW,
882 *val = thresh_data & LTR501_ALS_THRESH_MASK;
889 case IIO_EV_DIR_RISING:
890 ret = regmap_bulk_read(data->regmap,
895 *val = thresh_data & LTR501_PS_THRESH_MASK;
897 case IIO_EV_DIR_FALLING:
898 ret = regmap_bulk_read(data->regmap,
899 LTR501_PS_THRESH_LOW,
903 *val = thresh_data & LTR501_PS_THRESH_MASK;
915 static int ltr501_write_thresh(struct iio_dev *indio_dev,
916 const struct iio_chan_spec *chan,
917 enum iio_event_type type,
918 enum iio_event_direction dir,
919 enum iio_event_info info,
922 struct ltr501_data *data = iio_priv(indio_dev);
928 switch (chan->type) {
930 if (val > LTR501_ALS_THRESH_MASK)
933 case IIO_EV_DIR_RISING:
934 mutex_lock(&data->lock_als);
935 ret = regmap_bulk_write(data->regmap,
936 LTR501_ALS_THRESH_UP,
938 mutex_unlock(&data->lock_als);
940 case IIO_EV_DIR_FALLING:
941 mutex_lock(&data->lock_als);
942 ret = regmap_bulk_write(data->regmap,
943 LTR501_ALS_THRESH_LOW,
945 mutex_unlock(&data->lock_als);
951 if (val > LTR501_PS_THRESH_MASK)
954 case IIO_EV_DIR_RISING:
955 mutex_lock(&data->lock_ps);
956 ret = regmap_bulk_write(data->regmap,
959 mutex_unlock(&data->lock_ps);
961 case IIO_EV_DIR_FALLING:
962 mutex_lock(&data->lock_ps);
963 ret = regmap_bulk_write(data->regmap,
964 LTR501_PS_THRESH_LOW,
966 mutex_unlock(&data->lock_ps);
978 static int ltr501_read_event(struct iio_dev *indio_dev,
979 const struct iio_chan_spec *chan,
980 enum iio_event_type type,
981 enum iio_event_direction dir,
982 enum iio_event_info info,
988 case IIO_EV_INFO_VALUE:
989 return ltr501_read_thresh(indio_dev, chan, type, dir,
991 case IIO_EV_INFO_PERIOD:
992 ret = ltr501_read_intr_prst(iio_priv(indio_dev),
994 *val = *val2 / 1000000;
995 *val2 = *val2 % 1000000;
1004 static int ltr501_write_event(struct iio_dev *indio_dev,
1005 const struct iio_chan_spec *chan,
1006 enum iio_event_type type,
1007 enum iio_event_direction dir,
1008 enum iio_event_info info,
1012 case IIO_EV_INFO_VALUE:
1015 return ltr501_write_thresh(indio_dev, chan, type, dir,
1017 case IIO_EV_INFO_PERIOD:
1018 return ltr501_write_intr_prst(iio_priv(indio_dev), chan->type,
1027 static int ltr501_read_event_config(struct iio_dev *indio_dev,
1028 const struct iio_chan_spec *chan,
1029 enum iio_event_type type,
1030 enum iio_event_direction dir)
1032 struct ltr501_data *data = iio_priv(indio_dev);
1035 switch (chan->type) {
1037 ret = regmap_field_read(data->reg_als_intr, &status);
1042 ret = regmap_field_read(data->reg_ps_intr, &status);
1053 static int ltr501_write_event_config(struct iio_dev *indio_dev,
1054 const struct iio_chan_spec *chan,
1055 enum iio_event_type type,
1056 enum iio_event_direction dir, int state)
1058 struct ltr501_data *data = iio_priv(indio_dev);
1061 /* only 1 and 0 are valid inputs */
1062 if (state != 1 && state != 0)
1065 switch (chan->type) {
1067 mutex_lock(&data->lock_als);
1068 ret = regmap_field_write(data->reg_als_intr, state);
1069 mutex_unlock(&data->lock_als);
1072 mutex_lock(&data->lock_ps);
1073 ret = regmap_field_write(data->reg_ps_intr, state);
1074 mutex_unlock(&data->lock_ps);
1083 static ssize_t ltr501_show_proximity_scale_avail(struct device *dev,
1084 struct device_attribute *attr,
1087 struct ltr501_data *data = iio_priv(dev_to_iio_dev(dev));
1088 struct ltr501_chip_info *info = data->chip_info;
1092 for (i = 0; i < info->ps_gain_tbl_size; i++) {
1093 if (info->ps_gain[i].scale == LTR501_RESERVED_GAIN)
1095 len += scnprintf(buf + len, PAGE_SIZE - len, "%d.%06d ",
1096 info->ps_gain[i].scale,
1097 info->ps_gain[i].uscale);
1100 buf[len - 1] = '\n';
1105 static ssize_t ltr501_show_intensity_scale_avail(struct device *dev,
1106 struct device_attribute *attr,
1109 struct ltr501_data *data = iio_priv(dev_to_iio_dev(dev));
1110 struct ltr501_chip_info *info = data->chip_info;
1114 for (i = 0; i < info->als_gain_tbl_size; i++) {
1115 if (info->als_gain[i].scale == LTR501_RESERVED_GAIN)
1117 len += scnprintf(buf + len, PAGE_SIZE - len, "%d.%06d ",
1118 info->als_gain[i].scale,
1119 info->als_gain[i].uscale);
1122 buf[len - 1] = '\n';
1127 static IIO_CONST_ATTR_INT_TIME_AVAIL("0.05 0.1 0.2 0.4");
1128 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("20 10 5 2 1 0.5");
1130 static IIO_DEVICE_ATTR(in_proximity_scale_available, S_IRUGO,
1131 ltr501_show_proximity_scale_avail, NULL, 0);
1132 static IIO_DEVICE_ATTR(in_intensity_scale_available, S_IRUGO,
1133 ltr501_show_intensity_scale_avail, NULL, 0);
1135 static struct attribute *ltr501_attributes[] = {
1136 &iio_dev_attr_in_proximity_scale_available.dev_attr.attr,
1137 &iio_dev_attr_in_intensity_scale_available.dev_attr.attr,
1138 &iio_const_attr_integration_time_available.dev_attr.attr,
1139 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
1143 static struct attribute *ltr301_attributes[] = {
1144 &iio_dev_attr_in_intensity_scale_available.dev_attr.attr,
1145 &iio_const_attr_integration_time_available.dev_attr.attr,
1146 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
1150 static const struct attribute_group ltr501_attribute_group = {
1151 .attrs = ltr501_attributes,
1154 static const struct attribute_group ltr301_attribute_group = {
1155 .attrs = ltr301_attributes,
1158 static const struct iio_info ltr501_info_no_irq = {
1159 .read_raw = ltr501_read_raw,
1160 .write_raw = ltr501_write_raw,
1161 .attrs = <r501_attribute_group,
1164 static const struct iio_info ltr501_info = {
1165 .read_raw = ltr501_read_raw,
1166 .write_raw = ltr501_write_raw,
1167 .attrs = <r501_attribute_group,
1168 .read_event_value = <r501_read_event,
1169 .write_event_value = <r501_write_event,
1170 .read_event_config = <r501_read_event_config,
1171 .write_event_config = <r501_write_event_config,
1174 static const struct iio_info ltr301_info_no_irq = {
1175 .read_raw = ltr501_read_raw,
1176 .write_raw = ltr501_write_raw,
1177 .attrs = <r301_attribute_group,
1180 static const struct iio_info ltr301_info = {
1181 .read_raw = ltr501_read_raw,
1182 .write_raw = ltr501_write_raw,
1183 .attrs = <r301_attribute_group,
1184 .read_event_value = <r501_read_event,
1185 .write_event_value = <r501_write_event,
1186 .read_event_config = <r501_read_event_config,
1187 .write_event_config = <r501_write_event_config,
1190 static struct ltr501_chip_info ltr501_chip_info_tbl[] = {
1193 .als_gain = ltr501_als_gain_tbl,
1194 .als_gain_tbl_size = ARRAY_SIZE(ltr501_als_gain_tbl),
1195 .ps_gain = ltr501_ps_gain_tbl,
1196 .ps_gain_tbl_size = ARRAY_SIZE(ltr501_ps_gain_tbl),
1197 .als_mode_active = BIT(0) | BIT(1),
1198 .als_gain_mask = BIT(3),
1199 .als_gain_shift = 3,
1200 .info = <r501_info,
1201 .info_no_irq = <r501_info_no_irq,
1202 .channels = ltr501_channels,
1203 .no_channels = ARRAY_SIZE(ltr501_channels),
1207 .als_gain = ltr559_als_gain_tbl,
1208 .als_gain_tbl_size = ARRAY_SIZE(ltr559_als_gain_tbl),
1209 .ps_gain = ltr559_ps_gain_tbl,
1210 .ps_gain_tbl_size = ARRAY_SIZE(ltr559_ps_gain_tbl),
1211 .als_mode_active = BIT(1),
1212 .als_gain_mask = BIT(2) | BIT(3) | BIT(4),
1213 .als_gain_shift = 2,
1214 .info = <r501_info,
1215 .info_no_irq = <r501_info_no_irq,
1216 .channels = ltr501_channels,
1217 .no_channels = ARRAY_SIZE(ltr501_channels),
1221 .als_gain = ltr501_als_gain_tbl,
1222 .als_gain_tbl_size = ARRAY_SIZE(ltr501_als_gain_tbl),
1223 .als_mode_active = BIT(0) | BIT(1),
1224 .als_gain_mask = BIT(3),
1225 .als_gain_shift = 3,
1226 .info = <r301_info,
1227 .info_no_irq = <r301_info_no_irq,
1228 .channels = ltr301_channels,
1229 .no_channels = ARRAY_SIZE(ltr301_channels),
1233 static int ltr501_write_contr(struct ltr501_data *data, u8 als_val, u8 ps_val)
1237 ret = regmap_write(data->regmap, LTR501_ALS_CONTR, als_val);
1241 return regmap_write(data->regmap, LTR501_PS_CONTR, ps_val);
1244 static irqreturn_t ltr501_trigger_handler(int irq, void *p)
1246 struct iio_poll_func *pf = p;
1247 struct iio_dev *indio_dev = pf->indio_dev;
1248 struct ltr501_data *data = iio_priv(indio_dev);
1251 s64 ts __aligned(8);
1258 memset(&scan, 0, sizeof(scan));
1260 /* figure out which data needs to be ready */
1261 if (test_bit(0, indio_dev->active_scan_mask) ||
1262 test_bit(1, indio_dev->active_scan_mask))
1263 mask |= LTR501_STATUS_ALS_RDY;
1264 if (test_bit(2, indio_dev->active_scan_mask))
1265 mask |= LTR501_STATUS_PS_RDY;
1267 ret = ltr501_drdy(data, mask);
1271 if (mask & LTR501_STATUS_ALS_RDY) {
1272 ret = regmap_bulk_read(data->regmap, LTR501_ALS_DATA1,
1273 als_buf, sizeof(als_buf));
1276 if (test_bit(0, indio_dev->active_scan_mask))
1277 scan.channels[j++] = le16_to_cpu(als_buf[1]);
1278 if (test_bit(1, indio_dev->active_scan_mask))
1279 scan.channels[j++] = le16_to_cpu(als_buf[0]);
1282 if (mask & LTR501_STATUS_PS_RDY) {
1283 ret = regmap_bulk_read(data->regmap, LTR501_PS_DATA,
1287 scan.channels[j++] = psdata & LTR501_PS_DATA_MASK;
1290 iio_push_to_buffers_with_timestamp(indio_dev, &scan,
1291 iio_get_time_ns(indio_dev));
1294 iio_trigger_notify_done(indio_dev->trig);
1299 static irqreturn_t ltr501_interrupt_handler(int irq, void *private)
1301 struct iio_dev *indio_dev = private;
1302 struct ltr501_data *data = iio_priv(indio_dev);
1305 ret = regmap_read(data->regmap, LTR501_ALS_PS_STATUS, &status);
1307 dev_err(&data->client->dev,
1308 "irq read int reg failed\n");
1312 if (status & LTR501_STATUS_ALS_INTR)
1313 iio_push_event(indio_dev,
1314 IIO_UNMOD_EVENT_CODE(IIO_INTENSITY, 0,
1317 iio_get_time_ns(indio_dev));
1319 if (status & LTR501_STATUS_PS_INTR)
1320 iio_push_event(indio_dev,
1321 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
1324 iio_get_time_ns(indio_dev));
1329 static int ltr501_init(struct ltr501_data *data)
1333 ret = regmap_read(data->regmap, LTR501_ALS_CONTR, &status);
1337 data->als_contr = status | data->chip_info->als_mode_active;
1339 ret = regmap_read(data->regmap, LTR501_PS_CONTR, &status);
1343 data->ps_contr = status | LTR501_CONTR_ACTIVE;
1345 ret = ltr501_read_intr_prst(data, IIO_INTENSITY, &data->als_period);
1349 ret = ltr501_read_intr_prst(data, IIO_PROXIMITY, &data->ps_period);
1353 return ltr501_write_contr(data, data->als_contr, data->ps_contr);
1356 static bool ltr501_is_volatile_reg(struct device *dev, unsigned int reg)
1359 case LTR501_ALS_DATA1:
1360 case LTR501_ALS_DATA1_UPPER:
1361 case LTR501_ALS_DATA0:
1362 case LTR501_ALS_DATA0_UPPER:
1363 case LTR501_ALS_PS_STATUS:
1364 case LTR501_PS_DATA:
1365 case LTR501_PS_DATA_UPPER:
1372 static const struct regmap_config ltr501_regmap_config = {
1373 .name = LTR501_REGMAP_NAME,
1376 .max_register = LTR501_MAX_REG,
1377 .cache_type = REGCACHE_RBTREE,
1378 .volatile_reg = ltr501_is_volatile_reg,
1381 static int ltr501_powerdown(struct ltr501_data *data)
1383 return ltr501_write_contr(data, data->als_contr &
1384 ~data->chip_info->als_mode_active,
1385 data->ps_contr & ~LTR501_CONTR_ACTIVE);
1388 static const char *ltr501_match_acpi_device(struct device *dev, int *chip_idx)
1390 const struct acpi_device_id *id;
1392 id = acpi_match_device(dev->driver->acpi_match_table, dev);
1395 *chip_idx = id->driver_data;
1396 return dev_name(dev);
1399 static int ltr501_probe(struct i2c_client *client,
1400 const struct i2c_device_id *id)
1402 struct ltr501_data *data;
1403 struct iio_dev *indio_dev;
1404 struct regmap *regmap;
1405 int ret, partid, chip_idx = 0;
1406 const char *name = NULL;
1408 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
1412 regmap = devm_regmap_init_i2c(client, <r501_regmap_config);
1413 if (IS_ERR(regmap)) {
1414 dev_err(&client->dev, "Regmap initialization failed.\n");
1415 return PTR_ERR(regmap);
1418 data = iio_priv(indio_dev);
1419 i2c_set_clientdata(client, indio_dev);
1420 data->client = client;
1421 data->regmap = regmap;
1422 mutex_init(&data->lock_als);
1423 mutex_init(&data->lock_ps);
1425 data->reg_it = devm_regmap_field_alloc(&client->dev, regmap,
1427 if (IS_ERR(data->reg_it)) {
1428 dev_err(&client->dev, "Integ time reg field init failed.\n");
1429 return PTR_ERR(data->reg_it);
1432 data->reg_als_intr = devm_regmap_field_alloc(&client->dev, regmap,
1433 reg_field_als_intr);
1434 if (IS_ERR(data->reg_als_intr)) {
1435 dev_err(&client->dev, "ALS intr mode reg field init failed\n");
1436 return PTR_ERR(data->reg_als_intr);
1439 data->reg_ps_intr = devm_regmap_field_alloc(&client->dev, regmap,
1441 if (IS_ERR(data->reg_ps_intr)) {
1442 dev_err(&client->dev, "PS intr mode reg field init failed.\n");
1443 return PTR_ERR(data->reg_ps_intr);
1446 data->reg_als_rate = devm_regmap_field_alloc(&client->dev, regmap,
1447 reg_field_als_rate);
1448 if (IS_ERR(data->reg_als_rate)) {
1449 dev_err(&client->dev, "ALS samp rate field init failed.\n");
1450 return PTR_ERR(data->reg_als_rate);
1453 data->reg_ps_rate = devm_regmap_field_alloc(&client->dev, regmap,
1455 if (IS_ERR(data->reg_ps_rate)) {
1456 dev_err(&client->dev, "PS samp rate field init failed.\n");
1457 return PTR_ERR(data->reg_ps_rate);
1460 data->reg_als_prst = devm_regmap_field_alloc(&client->dev, regmap,
1461 reg_field_als_prst);
1462 if (IS_ERR(data->reg_als_prst)) {
1463 dev_err(&client->dev, "ALS prst reg field init failed\n");
1464 return PTR_ERR(data->reg_als_prst);
1467 data->reg_ps_prst = devm_regmap_field_alloc(&client->dev, regmap,
1469 if (IS_ERR(data->reg_ps_prst)) {
1470 dev_err(&client->dev, "PS prst reg field init failed.\n");
1471 return PTR_ERR(data->reg_ps_prst);
1474 ret = regmap_read(data->regmap, LTR501_PART_ID, &partid);
1480 chip_idx = id->driver_data;
1481 } else if (ACPI_HANDLE(&client->dev)) {
1482 name = ltr501_match_acpi_device(&client->dev, &chip_idx);
1487 data->chip_info = <r501_chip_info_tbl[chip_idx];
1489 if ((partid >> 4) != data->chip_info->partid)
1492 indio_dev->info = data->chip_info->info;
1493 indio_dev->channels = data->chip_info->channels;
1494 indio_dev->num_channels = data->chip_info->no_channels;
1495 indio_dev->name = name;
1496 indio_dev->modes = INDIO_DIRECT_MODE;
1498 ret = ltr501_init(data);
1502 if (client->irq > 0) {
1503 ret = devm_request_threaded_irq(&client->dev, client->irq,
1504 NULL, ltr501_interrupt_handler,
1505 IRQF_TRIGGER_FALLING |
1507 "ltr501_thresh_event",
1510 dev_err(&client->dev, "request irq (%d) failed\n",
1515 indio_dev->info = data->chip_info->info_no_irq;
1518 ret = iio_triggered_buffer_setup(indio_dev, NULL,
1519 ltr501_trigger_handler, NULL);
1521 goto powerdown_on_error;
1523 ret = iio_device_register(indio_dev);
1525 goto error_unreg_buffer;
1530 iio_triggered_buffer_cleanup(indio_dev);
1532 ltr501_powerdown(data);
1536 static int ltr501_remove(struct i2c_client *client)
1538 struct iio_dev *indio_dev = i2c_get_clientdata(client);
1540 iio_device_unregister(indio_dev);
1541 iio_triggered_buffer_cleanup(indio_dev);
1542 ltr501_powerdown(iio_priv(indio_dev));
1547 #ifdef CONFIG_PM_SLEEP
1548 static int ltr501_suspend(struct device *dev)
1550 struct ltr501_data *data = iio_priv(i2c_get_clientdata(
1551 to_i2c_client(dev)));
1552 return ltr501_powerdown(data);
1555 static int ltr501_resume(struct device *dev)
1557 struct ltr501_data *data = iio_priv(i2c_get_clientdata(
1558 to_i2c_client(dev)));
1560 return ltr501_write_contr(data, data->als_contr,
1565 static SIMPLE_DEV_PM_OPS(ltr501_pm_ops, ltr501_suspend, ltr501_resume);
1567 static const struct acpi_device_id ltr_acpi_match[] = {
1568 {"LTER0501", ltr501},
1569 {"LTER0559", ltr559},
1570 {"LTER0301", ltr301},
1573 MODULE_DEVICE_TABLE(acpi, ltr_acpi_match);
1575 static const struct i2c_device_id ltr501_id[] = {
1576 { "ltr501", ltr501},
1577 { "ltr559", ltr559},
1578 { "ltr301", ltr301},
1581 MODULE_DEVICE_TABLE(i2c, ltr501_id);
1583 static struct i2c_driver ltr501_driver = {
1585 .name = LTR501_DRV_NAME,
1586 .pm = <r501_pm_ops,
1587 .acpi_match_table = ACPI_PTR(ltr_acpi_match),
1589 .probe = ltr501_probe,
1590 .remove = ltr501_remove,
1591 .id_table = ltr501_id,
1594 module_i2c_driver(ltr501_driver);
1596 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
1597 MODULE_DESCRIPTION("Lite-On LTR501 ambient light and proximity sensor driver");
1598 MODULE_LICENSE("GPL");