2 * ltr501.c - Support for Lite-On LTR501 ambient light and proximity sensor
4 * Copyright 2014 Peter Meerwald <pmeerw@pmeerw.net>
6 * This file is subject to the terms and conditions of version 2 of
7 * the GNU General Public License. See the file COPYING in the main
8 * directory of this archive for more details.
10 * 7-bit I2C slave address 0x23
12 * TODO: IR LED characteristics
15 #include <linux/module.h>
16 #include <linux/i2c.h>
17 #include <linux/err.h>
18 #include <linux/delay.h>
19 #include <linux/regmap.h>
20 #include <linux/acpi.h>
22 #include <linux/iio/iio.h>
23 #include <linux/iio/events.h>
24 #include <linux/iio/sysfs.h>
25 #include <linux/iio/trigger_consumer.h>
26 #include <linux/iio/buffer.h>
27 #include <linux/iio/triggered_buffer.h>
29 #define LTR501_DRV_NAME "ltr501"
31 #define LTR501_ALS_CONTR 0x80 /* ALS operation mode, SW reset */
32 #define LTR501_PS_CONTR 0x81 /* PS operation mode */
33 #define LTR501_PS_MEAS_RATE 0x84 /* measurement rate*/
34 #define LTR501_ALS_MEAS_RATE 0x85 /* ALS integ time, measurement rate*/
35 #define LTR501_PART_ID 0x86
36 #define LTR501_MANUFAC_ID 0x87
37 #define LTR501_ALS_DATA1 0x88 /* 16-bit, little endian */
38 #define LTR501_ALS_DATA0 0x8a /* 16-bit, little endian */
39 #define LTR501_ALS_PS_STATUS 0x8c
40 #define LTR501_PS_DATA 0x8d /* 16-bit, little endian */
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, 0, 0);
78 static const struct reg_field reg_field_ps_intr =
79 REG_FIELD(LTR501_INTR, 1, 1);
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 struct ltr501_gain ltr501_als_gain_tbl[] = {
112 static struct ltr501_gain ltr559_als_gain_tbl[] = {
117 {LTR501_RESERVED_GAIN, LTR501_RESERVED_GAIN},
118 {LTR501_RESERVED_GAIN, LTR501_RESERVED_GAIN},
123 static struct ltr501_gain ltr501_ps_gain_tbl[] = {
130 static 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 struct ltr501_gain *als_gain;
140 int als_gain_tbl_size;
141 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 unsigned 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(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(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(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(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(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(struct ltr501_data *data, int *val, int *val2)
383 ret = regmap_field_read(data->reg_it, &index);
387 /* Make sure integ time index is valid */
388 if (index < 0 || index >= ARRAY_SIZE(int_time_mapping))
391 *val2 = int_time_mapping[index];
394 return IIO_VAL_INT_PLUS_MICRO;
397 static int ltr501_read_als(struct ltr501_data *data, __le16 buf[2])
401 ret = ltr501_drdy(data, LTR501_STATUS_ALS_RDY);
404 /* always read both ALS channels in given order */
405 return regmap_bulk_read(data->regmap, LTR501_ALS_DATA1,
406 buf, 2 * sizeof(__le16));
409 static int ltr501_read_ps(struct ltr501_data *data)
413 ret = ltr501_drdy(data, LTR501_STATUS_PS_RDY);
417 ret = regmap_bulk_read(data->regmap, LTR501_PS_DATA,
425 static int ltr501_read_intr_prst(struct ltr501_data *data,
426 enum iio_chan_type type,
429 int ret, samp_period, prst;
433 ret = regmap_field_read(data->reg_als_prst, &prst);
437 ret = ltr501_als_read_samp_period(data, &samp_period);
441 *val2 = samp_period * prst;
442 return IIO_VAL_INT_PLUS_MICRO;
444 ret = regmap_field_read(data->reg_ps_prst, &prst);
448 ret = ltr501_ps_read_samp_period(data, &samp_period);
453 *val2 = samp_period * prst;
454 return IIO_VAL_INT_PLUS_MICRO;
462 static int ltr501_write_intr_prst(struct ltr501_data *data,
463 enum iio_chan_type type,
466 int ret, samp_period, new_val;
467 unsigned long period;
469 if (val < 0 || val2 < 0)
472 /* period in microseconds */
473 period = ((val * 1000000) + val2);
477 ret = ltr501_als_read_samp_period(data, &samp_period);
481 /* period should be atleast equal to sampling period */
482 if (period < samp_period)
485 new_val = DIV_ROUND_UP(period, samp_period);
486 if (new_val < 0 || new_val > 0x0f)
489 mutex_lock(&data->lock_als);
490 ret = regmap_field_write(data->reg_als_prst, new_val);
491 mutex_unlock(&data->lock_als);
493 data->als_period = period;
497 ret = ltr501_ps_read_samp_period(data, &samp_period);
501 /* period should be atleast equal to rate */
502 if (period < samp_period)
505 new_val = DIV_ROUND_UP(period, samp_period);
506 if (new_val < 0 || new_val > 0x0f)
509 mutex_lock(&data->lock_ps);
510 ret = regmap_field_write(data->reg_ps_prst, new_val);
511 mutex_unlock(&data->lock_ps);
513 data->ps_period = period;
523 static const struct iio_event_spec ltr501_als_event_spec[] = {
525 .type = IIO_EV_TYPE_THRESH,
526 .dir = IIO_EV_DIR_RISING,
527 .mask_separate = BIT(IIO_EV_INFO_VALUE),
529 .type = IIO_EV_TYPE_THRESH,
530 .dir = IIO_EV_DIR_FALLING,
531 .mask_separate = BIT(IIO_EV_INFO_VALUE),
533 .type = IIO_EV_TYPE_THRESH,
534 .dir = IIO_EV_DIR_EITHER,
535 .mask_separate = BIT(IIO_EV_INFO_ENABLE) |
536 BIT(IIO_EV_INFO_PERIOD),
541 static const struct iio_event_spec ltr501_pxs_event_spec[] = {
543 .type = IIO_EV_TYPE_THRESH,
544 .dir = IIO_EV_DIR_RISING,
545 .mask_separate = BIT(IIO_EV_INFO_VALUE),
547 .type = IIO_EV_TYPE_THRESH,
548 .dir = IIO_EV_DIR_FALLING,
549 .mask_separate = BIT(IIO_EV_INFO_VALUE),
551 .type = IIO_EV_TYPE_THRESH,
552 .dir = IIO_EV_DIR_EITHER,
553 .mask_separate = BIT(IIO_EV_INFO_ENABLE) |
554 BIT(IIO_EV_INFO_PERIOD),
558 #define LTR501_INTENSITY_CHANNEL(_idx, _addr, _mod, _shared, \
559 _evspec, _evsize) { \
560 .type = IIO_INTENSITY, \
562 .address = (_addr), \
563 .channel2 = (_mod), \
564 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
565 .info_mask_shared_by_type = (_shared), \
566 .scan_index = (_idx), \
571 .endianness = IIO_CPU, \
573 .event_spec = _evspec,\
574 .num_event_specs = _evsize,\
577 #define LTR501_LIGHT_CHANNEL() { \
579 .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED), \
583 static const struct iio_chan_spec ltr501_channels[] = {
584 LTR501_LIGHT_CHANNEL(),
585 LTR501_INTENSITY_CHANNEL(0, LTR501_ALS_DATA0, IIO_MOD_LIGHT_BOTH, 0,
586 ltr501_als_event_spec,
587 ARRAY_SIZE(ltr501_als_event_spec)),
588 LTR501_INTENSITY_CHANNEL(1, LTR501_ALS_DATA1, IIO_MOD_LIGHT_IR,
589 BIT(IIO_CHAN_INFO_SCALE) |
590 BIT(IIO_CHAN_INFO_INT_TIME) |
591 BIT(IIO_CHAN_INFO_SAMP_FREQ),
594 .type = IIO_PROXIMITY,
595 .address = LTR501_PS_DATA,
596 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
597 BIT(IIO_CHAN_INFO_SCALE),
603 .endianness = IIO_CPU,
605 .event_spec = ltr501_pxs_event_spec,
606 .num_event_specs = ARRAY_SIZE(ltr501_pxs_event_spec),
608 IIO_CHAN_SOFT_TIMESTAMP(3),
611 static const struct iio_chan_spec ltr301_channels[] = {
612 LTR501_LIGHT_CHANNEL(),
613 LTR501_INTENSITY_CHANNEL(0, LTR501_ALS_DATA0, IIO_MOD_LIGHT_BOTH, 0,
614 ltr501_als_event_spec,
615 ARRAY_SIZE(ltr501_als_event_spec)),
616 LTR501_INTENSITY_CHANNEL(1, LTR501_ALS_DATA1, IIO_MOD_LIGHT_IR,
617 BIT(IIO_CHAN_INFO_SCALE) |
618 BIT(IIO_CHAN_INFO_INT_TIME) |
619 BIT(IIO_CHAN_INFO_SAMP_FREQ),
621 IIO_CHAN_SOFT_TIMESTAMP(2),
624 static int ltr501_read_raw(struct iio_dev *indio_dev,
625 struct iio_chan_spec const *chan,
626 int *val, int *val2, long mask)
628 struct ltr501_data *data = iio_priv(indio_dev);
633 case IIO_CHAN_INFO_PROCESSED:
634 if (iio_buffer_enabled(indio_dev))
637 switch (chan->type) {
639 mutex_lock(&data->lock_als);
640 ret = ltr501_read_als(data, buf);
641 mutex_unlock(&data->lock_als);
644 *val = ltr501_calculate_lux(le16_to_cpu(buf[1]),
645 le16_to_cpu(buf[0]));
650 case IIO_CHAN_INFO_RAW:
651 if (iio_buffer_enabled(indio_dev))
654 switch (chan->type) {
656 mutex_lock(&data->lock_als);
657 ret = ltr501_read_als(data, buf);
658 mutex_unlock(&data->lock_als);
661 *val = le16_to_cpu(chan->address == LTR501_ALS_DATA1 ?
665 mutex_lock(&data->lock_ps);
666 ret = ltr501_read_ps(data);
667 mutex_unlock(&data->lock_ps);
670 *val = ret & LTR501_PS_DATA_MASK;
675 case IIO_CHAN_INFO_SCALE:
676 switch (chan->type) {
678 i = (data->als_contr & data->chip_info->als_gain_mask)
679 >> data->chip_info->als_gain_shift;
680 *val = data->chip_info->als_gain[i].scale;
681 *val2 = data->chip_info->als_gain[i].uscale;
682 return IIO_VAL_INT_PLUS_MICRO;
684 i = (data->ps_contr & LTR501_CONTR_PS_GAIN_MASK) >>
685 LTR501_CONTR_PS_GAIN_SHIFT;
686 *val = data->chip_info->ps_gain[i].scale;
687 *val2 = data->chip_info->ps_gain[i].uscale;
688 return IIO_VAL_INT_PLUS_MICRO;
692 case IIO_CHAN_INFO_INT_TIME:
693 switch (chan->type) {
695 return ltr501_read_it_time(data, val, val2);
699 case IIO_CHAN_INFO_SAMP_FREQ:
700 switch (chan->type) {
702 return ltr501_als_read_samp_freq(data, val, val2);
704 return ltr501_ps_read_samp_freq(data, val, val2);
712 static int ltr501_get_gain_index(struct ltr501_gain *gain, int size,
717 for (i = 0; i < size; i++)
718 if (val == gain[i].scale && val2 == gain[i].uscale)
724 static int ltr501_write_raw(struct iio_dev *indio_dev,
725 struct iio_chan_spec const *chan,
726 int val, int val2, long mask)
728 struct ltr501_data *data = iio_priv(indio_dev);
729 int i, ret, freq_val, freq_val2;
730 struct ltr501_chip_info *info = data->chip_info;
732 if (iio_buffer_enabled(indio_dev))
736 case IIO_CHAN_INFO_SCALE:
737 switch (chan->type) {
739 i = ltr501_get_gain_index(info->als_gain,
740 info->als_gain_tbl_size,
745 data->als_contr &= ~info->als_gain_mask;
746 data->als_contr |= i << info->als_gain_shift;
748 return regmap_write(data->regmap, LTR501_ALS_CONTR,
751 i = ltr501_get_gain_index(info->ps_gain,
752 info->ps_gain_tbl_size,
756 data->ps_contr &= ~LTR501_CONTR_PS_GAIN_MASK;
757 data->ps_contr |= i << LTR501_CONTR_PS_GAIN_SHIFT;
759 return regmap_write(data->regmap, LTR501_PS_CONTR,
764 case IIO_CHAN_INFO_INT_TIME:
765 switch (chan->type) {
769 mutex_lock(&data->lock_als);
770 i = ltr501_set_it_time(data, val2);
771 mutex_unlock(&data->lock_als);
776 case IIO_CHAN_INFO_SAMP_FREQ:
777 switch (chan->type) {
779 ret = ltr501_als_read_samp_freq(data, &freq_val,
784 ret = ltr501_als_write_samp_freq(data, val, val2);
788 /* update persistence count when changing frequency */
789 ret = ltr501_write_intr_prst(data, chan->type,
790 0, data->als_period);
793 return ltr501_als_write_samp_freq(data,
798 ret = ltr501_ps_read_samp_freq(data, &freq_val,
803 ret = ltr501_ps_write_samp_freq(data, val, val2);
807 /* update persistence count when changing frequency */
808 ret = ltr501_write_intr_prst(data, chan->type,
812 return ltr501_ps_write_samp_freq(data,
823 static int ltr501_read_thresh(struct iio_dev *indio_dev,
824 const struct iio_chan_spec *chan,
825 enum iio_event_type type,
826 enum iio_event_direction dir,
827 enum iio_event_info info,
830 struct ltr501_data *data = iio_priv(indio_dev);
831 int ret, thresh_data;
833 switch (chan->type) {
836 case IIO_EV_DIR_RISING:
837 ret = regmap_bulk_read(data->regmap,
838 LTR501_ALS_THRESH_UP,
842 *val = thresh_data & LTR501_ALS_THRESH_MASK;
844 case IIO_EV_DIR_FALLING:
845 ret = regmap_bulk_read(data->regmap,
846 LTR501_ALS_THRESH_LOW,
850 *val = thresh_data & LTR501_ALS_THRESH_MASK;
857 case IIO_EV_DIR_RISING:
858 ret = regmap_bulk_read(data->regmap,
863 *val = thresh_data & LTR501_PS_THRESH_MASK;
865 case IIO_EV_DIR_FALLING:
866 ret = regmap_bulk_read(data->regmap,
867 LTR501_PS_THRESH_LOW,
871 *val = thresh_data & LTR501_PS_THRESH_MASK;
883 static int ltr501_write_thresh(struct iio_dev *indio_dev,
884 const struct iio_chan_spec *chan,
885 enum iio_event_type type,
886 enum iio_event_direction dir,
887 enum iio_event_info info,
890 struct ltr501_data *data = iio_priv(indio_dev);
896 switch (chan->type) {
898 if (val > LTR501_ALS_THRESH_MASK)
901 case IIO_EV_DIR_RISING:
902 mutex_lock(&data->lock_als);
903 ret = regmap_bulk_write(data->regmap,
904 LTR501_ALS_THRESH_UP,
906 mutex_unlock(&data->lock_als);
908 case IIO_EV_DIR_FALLING:
909 mutex_lock(&data->lock_als);
910 ret = regmap_bulk_write(data->regmap,
911 LTR501_ALS_THRESH_LOW,
913 mutex_unlock(&data->lock_als);
919 if (val > LTR501_PS_THRESH_MASK)
922 case IIO_EV_DIR_RISING:
923 mutex_lock(&data->lock_ps);
924 ret = regmap_bulk_write(data->regmap,
927 mutex_unlock(&data->lock_ps);
929 case IIO_EV_DIR_FALLING:
930 mutex_lock(&data->lock_ps);
931 ret = regmap_bulk_write(data->regmap,
932 LTR501_PS_THRESH_LOW,
934 mutex_unlock(&data->lock_ps);
946 static int ltr501_read_event(struct iio_dev *indio_dev,
947 const struct iio_chan_spec *chan,
948 enum iio_event_type type,
949 enum iio_event_direction dir,
950 enum iio_event_info info,
956 case IIO_EV_INFO_VALUE:
957 return ltr501_read_thresh(indio_dev, chan, type, dir,
959 case IIO_EV_INFO_PERIOD:
960 ret = ltr501_read_intr_prst(iio_priv(indio_dev),
962 *val = *val2 / 1000000;
963 *val2 = *val2 % 1000000;
972 static int ltr501_write_event(struct iio_dev *indio_dev,
973 const struct iio_chan_spec *chan,
974 enum iio_event_type type,
975 enum iio_event_direction dir,
976 enum iio_event_info info,
980 case IIO_EV_INFO_VALUE:
983 return ltr501_write_thresh(indio_dev, chan, type, dir,
985 case IIO_EV_INFO_PERIOD:
986 return ltr501_write_intr_prst(iio_priv(indio_dev), chan->type,
995 static int ltr501_read_event_config(struct iio_dev *indio_dev,
996 const struct iio_chan_spec *chan,
997 enum iio_event_type type,
998 enum iio_event_direction dir)
1000 struct ltr501_data *data = iio_priv(indio_dev);
1003 switch (chan->type) {
1005 ret = regmap_field_read(data->reg_als_intr, &status);
1010 ret = regmap_field_read(data->reg_ps_intr, &status);
1021 static int ltr501_write_event_config(struct iio_dev *indio_dev,
1022 const struct iio_chan_spec *chan,
1023 enum iio_event_type type,
1024 enum iio_event_direction dir, int state)
1026 struct ltr501_data *data = iio_priv(indio_dev);
1029 /* only 1 and 0 are valid inputs */
1030 if (state != 1 && state != 0)
1033 switch (chan->type) {
1035 mutex_lock(&data->lock_als);
1036 ret = regmap_field_write(data->reg_als_intr, state);
1037 mutex_unlock(&data->lock_als);
1040 mutex_lock(&data->lock_ps);
1041 ret = regmap_field_write(data->reg_ps_intr, state);
1042 mutex_unlock(&data->lock_ps);
1051 static ssize_t ltr501_show_proximity_scale_avail(struct device *dev,
1052 struct device_attribute *attr,
1055 struct ltr501_data *data = iio_priv(dev_to_iio_dev(dev));
1056 struct ltr501_chip_info *info = data->chip_info;
1060 for (i = 0; i < info->ps_gain_tbl_size; i++) {
1061 if (info->ps_gain[i].scale == LTR501_RESERVED_GAIN)
1063 len += scnprintf(buf + len, PAGE_SIZE - len, "%d.%06d ",
1064 info->ps_gain[i].scale,
1065 info->ps_gain[i].uscale);
1068 buf[len - 1] = '\n';
1073 static ssize_t ltr501_show_intensity_scale_avail(struct device *dev,
1074 struct device_attribute *attr,
1077 struct ltr501_data *data = iio_priv(dev_to_iio_dev(dev));
1078 struct ltr501_chip_info *info = data->chip_info;
1082 for (i = 0; i < info->als_gain_tbl_size; i++) {
1083 if (info->als_gain[i].scale == LTR501_RESERVED_GAIN)
1085 len += scnprintf(buf + len, PAGE_SIZE - len, "%d.%06d ",
1086 info->als_gain[i].scale,
1087 info->als_gain[i].uscale);
1090 buf[len - 1] = '\n';
1095 static IIO_CONST_ATTR_INT_TIME_AVAIL("0.05 0.1 0.2 0.4");
1096 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("20 10 5 2 1 0.5");
1098 static IIO_DEVICE_ATTR(in_proximity_scale_available, S_IRUGO,
1099 ltr501_show_proximity_scale_avail, NULL, 0);
1100 static IIO_DEVICE_ATTR(in_intensity_scale_available, S_IRUGO,
1101 ltr501_show_intensity_scale_avail, NULL, 0);
1103 static struct attribute *ltr501_attributes[] = {
1104 &iio_dev_attr_in_proximity_scale_available.dev_attr.attr,
1105 &iio_dev_attr_in_intensity_scale_available.dev_attr.attr,
1106 &iio_const_attr_integration_time_available.dev_attr.attr,
1107 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
1111 static struct attribute *ltr301_attributes[] = {
1112 &iio_dev_attr_in_intensity_scale_available.dev_attr.attr,
1113 &iio_const_attr_integration_time_available.dev_attr.attr,
1114 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
1118 static const struct attribute_group ltr501_attribute_group = {
1119 .attrs = ltr501_attributes,
1122 static const struct attribute_group ltr301_attribute_group = {
1123 .attrs = ltr301_attributes,
1126 static const struct iio_info ltr501_info_no_irq = {
1127 .read_raw = ltr501_read_raw,
1128 .write_raw = ltr501_write_raw,
1129 .attrs = <r501_attribute_group,
1130 .driver_module = THIS_MODULE,
1133 static const struct iio_info ltr501_info = {
1134 .read_raw = ltr501_read_raw,
1135 .write_raw = ltr501_write_raw,
1136 .attrs = <r501_attribute_group,
1137 .read_event_value = <r501_read_event,
1138 .write_event_value = <r501_write_event,
1139 .read_event_config = <r501_read_event_config,
1140 .write_event_config = <r501_write_event_config,
1141 .driver_module = THIS_MODULE,
1144 static const struct iio_info ltr301_info_no_irq = {
1145 .read_raw = ltr501_read_raw,
1146 .write_raw = ltr501_write_raw,
1147 .attrs = <r301_attribute_group,
1148 .driver_module = THIS_MODULE,
1151 static const struct iio_info ltr301_info = {
1152 .read_raw = ltr501_read_raw,
1153 .write_raw = ltr501_write_raw,
1154 .attrs = <r301_attribute_group,
1155 .read_event_value = <r501_read_event,
1156 .write_event_value = <r501_write_event,
1157 .read_event_config = <r501_read_event_config,
1158 .write_event_config = <r501_write_event_config,
1159 .driver_module = THIS_MODULE,
1162 static struct ltr501_chip_info ltr501_chip_info_tbl[] = {
1165 .als_gain = ltr501_als_gain_tbl,
1166 .als_gain_tbl_size = ARRAY_SIZE(ltr501_als_gain_tbl),
1167 .ps_gain = ltr501_ps_gain_tbl,
1168 .ps_gain_tbl_size = ARRAY_SIZE(ltr501_ps_gain_tbl),
1169 .als_mode_active = BIT(0) | BIT(1),
1170 .als_gain_mask = BIT(3),
1171 .als_gain_shift = 3,
1172 .info = <r501_info,
1173 .info_no_irq = <r501_info_no_irq,
1174 .channels = ltr501_channels,
1175 .no_channels = ARRAY_SIZE(ltr501_channels),
1179 .als_gain = ltr559_als_gain_tbl,
1180 .als_gain_tbl_size = ARRAY_SIZE(ltr559_als_gain_tbl),
1181 .ps_gain = ltr559_ps_gain_tbl,
1182 .ps_gain_tbl_size = ARRAY_SIZE(ltr559_ps_gain_tbl),
1183 .als_mode_active = BIT(1),
1184 .als_gain_mask = BIT(2) | BIT(3) | BIT(4),
1185 .als_gain_shift = 2,
1186 .info = <r501_info,
1187 .info_no_irq = <r501_info_no_irq,
1188 .channels = ltr501_channels,
1189 .no_channels = ARRAY_SIZE(ltr501_channels),
1193 .als_gain = ltr501_als_gain_tbl,
1194 .als_gain_tbl_size = ARRAY_SIZE(ltr501_als_gain_tbl),
1195 .als_mode_active = BIT(0) | BIT(1),
1196 .als_gain_mask = BIT(3),
1197 .als_gain_shift = 3,
1198 .info = <r301_info,
1199 .info_no_irq = <r301_info_no_irq,
1200 .channels = ltr301_channels,
1201 .no_channels = ARRAY_SIZE(ltr301_channels),
1205 static int ltr501_write_contr(struct ltr501_data *data, u8 als_val, u8 ps_val)
1209 ret = regmap_write(data->regmap, LTR501_ALS_CONTR, als_val);
1213 return regmap_write(data->regmap, LTR501_PS_CONTR, ps_val);
1216 static irqreturn_t ltr501_trigger_handler(int irq, void *p)
1218 struct iio_poll_func *pf = p;
1219 struct iio_dev *indio_dev = pf->indio_dev;
1220 struct ltr501_data *data = iio_priv(indio_dev);
1227 memset(buf, 0, sizeof(buf));
1229 /* figure out which data needs to be ready */
1230 if (test_bit(0, indio_dev->active_scan_mask) ||
1231 test_bit(1, indio_dev->active_scan_mask))
1232 mask |= LTR501_STATUS_ALS_RDY;
1233 if (test_bit(2, indio_dev->active_scan_mask))
1234 mask |= LTR501_STATUS_PS_RDY;
1236 ret = ltr501_drdy(data, mask);
1240 if (mask & LTR501_STATUS_ALS_RDY) {
1241 ret = regmap_bulk_read(data->regmap, LTR501_ALS_DATA1,
1242 (u8 *)als_buf, sizeof(als_buf));
1245 if (test_bit(0, indio_dev->active_scan_mask))
1246 buf[j++] = le16_to_cpu(als_buf[1]);
1247 if (test_bit(1, indio_dev->active_scan_mask))
1248 buf[j++] = le16_to_cpu(als_buf[0]);
1251 if (mask & LTR501_STATUS_PS_RDY) {
1252 ret = regmap_bulk_read(data->regmap, LTR501_PS_DATA,
1256 buf[j++] = psdata & LTR501_PS_DATA_MASK;
1259 iio_push_to_buffers_with_timestamp(indio_dev, buf, iio_get_time_ns());
1262 iio_trigger_notify_done(indio_dev->trig);
1267 static irqreturn_t ltr501_interrupt_handler(int irq, void *private)
1269 struct iio_dev *indio_dev = private;
1270 struct ltr501_data *data = iio_priv(indio_dev);
1273 ret = regmap_read(data->regmap, LTR501_ALS_PS_STATUS, &status);
1275 dev_err(&data->client->dev,
1276 "irq read int reg failed\n");
1280 if (status & LTR501_STATUS_ALS_INTR)
1281 iio_push_event(indio_dev,
1282 IIO_UNMOD_EVENT_CODE(IIO_INTENSITY, 0,
1287 if (status & LTR501_STATUS_PS_INTR)
1288 iio_push_event(indio_dev,
1289 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
1297 static int ltr501_init(struct ltr501_data *data)
1301 ret = regmap_read(data->regmap, LTR501_ALS_CONTR, &status);
1305 data->als_contr = ret | data->chip_info->als_mode_active;
1307 ret = regmap_read(data->regmap, LTR501_PS_CONTR, &status);
1311 data->ps_contr = status | LTR501_CONTR_ACTIVE;
1313 ret = ltr501_read_intr_prst(data, IIO_INTENSITY, &data->als_period);
1317 ret = ltr501_read_intr_prst(data, IIO_PROXIMITY, &data->ps_period);
1321 return ltr501_write_contr(data, data->als_contr, data->ps_contr);
1324 static bool ltr501_is_volatile_reg(struct device *dev, unsigned int reg)
1327 case LTR501_ALS_DATA1:
1328 case LTR501_ALS_DATA0:
1329 case LTR501_ALS_PS_STATUS:
1330 case LTR501_PS_DATA:
1337 static struct regmap_config ltr501_regmap_config = {
1338 .name = LTR501_REGMAP_NAME,
1341 .max_register = LTR501_MAX_REG,
1342 .cache_type = REGCACHE_RBTREE,
1343 .volatile_reg = ltr501_is_volatile_reg,
1346 static int ltr501_powerdown(struct ltr501_data *data)
1348 return ltr501_write_contr(data, data->als_contr &
1349 ~data->chip_info->als_mode_active,
1350 data->ps_contr & ~LTR501_CONTR_ACTIVE);
1353 static const char *ltr501_match_acpi_device(struct device *dev, int *chip_idx)
1355 const struct acpi_device_id *id;
1357 id = acpi_match_device(dev->driver->acpi_match_table, dev);
1360 *chip_idx = id->driver_data;
1361 return dev_name(dev);
1364 static int ltr501_probe(struct i2c_client *client,
1365 const struct i2c_device_id *id)
1367 struct ltr501_data *data;
1368 struct iio_dev *indio_dev;
1369 struct regmap *regmap;
1370 int ret, partid, chip_idx = 0;
1371 const char *name = NULL;
1373 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
1377 regmap = devm_regmap_init_i2c(client, <r501_regmap_config);
1378 if (IS_ERR(regmap)) {
1379 dev_err(&client->dev, "Regmap initialization failed.\n");
1380 return PTR_ERR(regmap);
1383 data = iio_priv(indio_dev);
1384 i2c_set_clientdata(client, indio_dev);
1385 data->client = client;
1386 data->regmap = regmap;
1387 mutex_init(&data->lock_als);
1388 mutex_init(&data->lock_ps);
1390 data->reg_it = devm_regmap_field_alloc(&client->dev, regmap,
1392 if (IS_ERR(data->reg_it)) {
1393 dev_err(&client->dev, "Integ time reg field init failed.\n");
1394 return PTR_ERR(data->reg_it);
1397 data->reg_als_intr = devm_regmap_field_alloc(&client->dev, regmap,
1398 reg_field_als_intr);
1399 if (IS_ERR(data->reg_als_intr)) {
1400 dev_err(&client->dev, "ALS intr mode reg field init failed\n");
1401 return PTR_ERR(data->reg_als_intr);
1404 data->reg_ps_intr = devm_regmap_field_alloc(&client->dev, regmap,
1406 if (IS_ERR(data->reg_ps_intr)) {
1407 dev_err(&client->dev, "PS intr mode reg field init failed.\n");
1408 return PTR_ERR(data->reg_ps_intr);
1411 data->reg_als_rate = devm_regmap_field_alloc(&client->dev, regmap,
1412 reg_field_als_rate);
1413 if (IS_ERR(data->reg_als_rate)) {
1414 dev_err(&client->dev, "ALS samp rate field init failed.\n");
1415 return PTR_ERR(data->reg_als_rate);
1418 data->reg_ps_rate = devm_regmap_field_alloc(&client->dev, regmap,
1420 if (IS_ERR(data->reg_ps_rate)) {
1421 dev_err(&client->dev, "PS samp rate field init failed.\n");
1422 return PTR_ERR(data->reg_ps_rate);
1425 data->reg_als_prst = devm_regmap_field_alloc(&client->dev, regmap,
1426 reg_field_als_prst);
1427 if (IS_ERR(data->reg_als_prst)) {
1428 dev_err(&client->dev, "ALS prst reg field init failed\n");
1429 return PTR_ERR(data->reg_als_prst);
1432 data->reg_ps_prst = devm_regmap_field_alloc(&client->dev, regmap,
1434 if (IS_ERR(data->reg_ps_prst)) {
1435 dev_err(&client->dev, "PS prst reg field init failed.\n");
1436 return PTR_ERR(data->reg_ps_prst);
1439 ret = regmap_read(data->regmap, LTR501_PART_ID, &partid);
1445 chip_idx = id->driver_data;
1446 } else if (ACPI_HANDLE(&client->dev)) {
1447 name = ltr501_match_acpi_device(&client->dev, &chip_idx);
1452 data->chip_info = <r501_chip_info_tbl[chip_idx];
1454 if ((partid >> 4) != data->chip_info->partid)
1457 indio_dev->dev.parent = &client->dev;
1458 indio_dev->info = data->chip_info->info;
1459 indio_dev->channels = data->chip_info->channels;
1460 indio_dev->num_channels = data->chip_info->no_channels;
1461 indio_dev->name = name;
1462 indio_dev->modes = INDIO_DIRECT_MODE;
1464 ret = ltr501_init(data);
1468 if (client->irq > 0) {
1469 ret = devm_request_threaded_irq(&client->dev, client->irq,
1470 NULL, ltr501_interrupt_handler,
1471 IRQF_TRIGGER_FALLING |
1473 "ltr501_thresh_event",
1476 dev_err(&client->dev, "request irq (%d) failed\n",
1481 indio_dev->info = data->chip_info->info_no_irq;
1484 ret = iio_triggered_buffer_setup(indio_dev, NULL,
1485 ltr501_trigger_handler, NULL);
1487 goto powerdown_on_error;
1489 ret = iio_device_register(indio_dev);
1491 goto error_unreg_buffer;
1496 iio_triggered_buffer_cleanup(indio_dev);
1498 ltr501_powerdown(data);
1502 static int ltr501_remove(struct i2c_client *client)
1504 struct iio_dev *indio_dev = i2c_get_clientdata(client);
1506 iio_device_unregister(indio_dev);
1507 iio_triggered_buffer_cleanup(indio_dev);
1508 ltr501_powerdown(iio_priv(indio_dev));
1513 #ifdef CONFIG_PM_SLEEP
1514 static int ltr501_suspend(struct device *dev)
1516 struct ltr501_data *data = iio_priv(i2c_get_clientdata(
1517 to_i2c_client(dev)));
1518 return ltr501_powerdown(data);
1521 static int ltr501_resume(struct device *dev)
1523 struct ltr501_data *data = iio_priv(i2c_get_clientdata(
1524 to_i2c_client(dev)));
1526 return ltr501_write_contr(data, data->als_contr,
1531 static SIMPLE_DEV_PM_OPS(ltr501_pm_ops, ltr501_suspend, ltr501_resume);
1533 static const struct acpi_device_id ltr_acpi_match[] = {
1534 {"LTER0501", ltr501},
1535 {"LTER0559", ltr559},
1536 {"LTER0301", ltr301},
1539 MODULE_DEVICE_TABLE(acpi, ltr_acpi_match);
1541 static const struct i2c_device_id ltr501_id[] = {
1542 { "ltr501", ltr501},
1543 { "ltr559", ltr559},
1544 { "ltr301", ltr301},
1547 MODULE_DEVICE_TABLE(i2c, ltr501_id);
1549 static struct i2c_driver ltr501_driver = {
1551 .name = LTR501_DRV_NAME,
1552 .pm = <r501_pm_ops,
1553 .acpi_match_table = ACPI_PTR(ltr_acpi_match),
1554 .owner = THIS_MODULE,
1556 .probe = ltr501_probe,
1557 .remove = ltr501_remove,
1558 .id_table = ltr501_id,
1561 module_i2c_driver(ltr501_driver);
1563 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
1564 MODULE_DESCRIPTION("Lite-On LTR501 ambient light and proximity sensor driver");
1565 MODULE_LICENSE("GPL");