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_DATA1_UPPER 0x89 /* upper 8 bits of LTR501_ALS_DATA1 */
39 #define LTR501_ALS_DATA0 0x8a /* 16-bit, little endian */
40 #define LTR501_ALS_DATA0_UPPER 0x8b /* upper 8 bits of LTR501_ALS_DATA0 */
41 #define LTR501_ALS_PS_STATUS 0x8c
42 #define LTR501_PS_DATA 0x8d /* 16-bit, little endian */
43 #define LTR501_PS_DATA_UPPER 0x8e /* upper 8 bits of LTR501_PS_DATA */
44 #define LTR501_INTR 0x8f /* output mode, polarity, mode */
45 #define LTR501_PS_THRESH_UP 0x90 /* 11 bit, ps upper threshold */
46 #define LTR501_PS_THRESH_LOW 0x92 /* 11 bit, ps lower threshold */
47 #define LTR501_ALS_THRESH_UP 0x97 /* 16 bit, ALS upper threshold */
48 #define LTR501_ALS_THRESH_LOW 0x99 /* 16 bit, ALS lower threshold */
49 #define LTR501_INTR_PRST 0x9e /* ps thresh, als thresh */
50 #define LTR501_MAX_REG 0x9f
52 #define LTR501_ALS_CONTR_SW_RESET BIT(2)
53 #define LTR501_CONTR_PS_GAIN_MASK (BIT(3) | BIT(2))
54 #define LTR501_CONTR_PS_GAIN_SHIFT 2
55 #define LTR501_CONTR_ALS_GAIN_MASK BIT(3)
56 #define LTR501_CONTR_ACTIVE BIT(1)
58 #define LTR501_STATUS_ALS_INTR BIT(3)
59 #define LTR501_STATUS_ALS_RDY BIT(2)
60 #define LTR501_STATUS_PS_INTR BIT(1)
61 #define LTR501_STATUS_PS_RDY BIT(0)
63 #define LTR501_PS_DATA_MASK 0x7ff
64 #define LTR501_PS_THRESH_MASK 0x7ff
65 #define LTR501_ALS_THRESH_MASK 0xffff
67 #define LTR501_ALS_DEF_PERIOD 500000
68 #define LTR501_PS_DEF_PERIOD 100000
70 #define LTR501_REGMAP_NAME "ltr501_regmap"
72 #define LTR501_LUX_CONV(vis_coeff, vis_data, ir_coeff, ir_data) \
73 ((vis_coeff * vis_data) - (ir_coeff * ir_data))
75 static const int int_time_mapping[] = {100000, 50000, 200000, 400000};
77 static const struct reg_field reg_field_it =
78 REG_FIELD(LTR501_ALS_MEAS_RATE, 3, 4);
79 static const struct reg_field reg_field_als_intr =
80 REG_FIELD(LTR501_INTR, 1, 1);
81 static const struct reg_field reg_field_ps_intr =
82 REG_FIELD(LTR501_INTR, 0, 0);
83 static const struct reg_field reg_field_als_rate =
84 REG_FIELD(LTR501_ALS_MEAS_RATE, 0, 2);
85 static const struct reg_field reg_field_ps_rate =
86 REG_FIELD(LTR501_PS_MEAS_RATE, 0, 3);
87 static const struct reg_field reg_field_als_prst =
88 REG_FIELD(LTR501_INTR_PRST, 0, 3);
89 static const struct reg_field reg_field_ps_prst =
90 REG_FIELD(LTR501_INTR_PRST, 4, 7);
92 struct ltr501_samp_table {
93 int freq_val; /* repetition frequency in micro HZ*/
94 int time_val; /* repetition rate in micro seconds */
97 #define LTR501_RESERVED_GAIN -1
110 static struct ltr501_gain ltr501_als_gain_tbl[] = {
115 static struct ltr501_gain ltr559_als_gain_tbl[] = {
120 {LTR501_RESERVED_GAIN, LTR501_RESERVED_GAIN},
121 {LTR501_RESERVED_GAIN, LTR501_RESERVED_GAIN},
126 static struct ltr501_gain ltr501_ps_gain_tbl[] = {
133 static struct ltr501_gain ltr559_ps_gain_tbl[] = {
134 {0, 62500}, /* x16 gain */
135 {0, 31250}, /* x32 gain */
136 {0, 15625}, /* bits X1 are for x64 gain */
140 struct ltr501_chip_info {
142 struct ltr501_gain *als_gain;
143 int als_gain_tbl_size;
144 struct ltr501_gain *ps_gain;
145 int ps_gain_tbl_size;
149 struct iio_chan_spec const *channels;
150 const int no_channels;
151 const struct iio_info *info;
152 const struct iio_info *info_no_irq;
156 struct i2c_client *client;
157 struct mutex lock_als, lock_ps;
158 struct ltr501_chip_info *chip_info;
159 u8 als_contr, ps_contr;
160 int als_period, ps_period; /* period in micro seconds */
161 struct regmap *regmap;
162 struct regmap_field *reg_it;
163 struct regmap_field *reg_als_intr;
164 struct regmap_field *reg_ps_intr;
165 struct regmap_field *reg_als_rate;
166 struct regmap_field *reg_ps_rate;
167 struct regmap_field *reg_als_prst;
168 struct regmap_field *reg_ps_prst;
171 static const struct ltr501_samp_table ltr501_als_samp_table[] = {
172 {20000000, 50000}, {10000000, 100000},
173 {5000000, 200000}, {2000000, 500000},
174 {1000000, 1000000}, {500000, 2000000},
175 {500000, 2000000}, {500000, 2000000}
178 static const struct ltr501_samp_table ltr501_ps_samp_table[] = {
179 {20000000, 50000}, {14285714, 70000},
180 {10000000, 100000}, {5000000, 200000},
181 {2000000, 500000}, {1000000, 1000000},
182 {500000, 2000000}, {500000, 2000000},
186 static int ltr501_match_samp_freq(const struct ltr501_samp_table *tab,
187 int len, int val, int val2)
191 freq = val * 1000000 + val2;
193 for (i = 0; i < len; i++) {
194 if (tab[i].freq_val == freq)
201 static int ltr501_als_read_samp_freq(struct ltr501_data *data,
206 ret = regmap_field_read(data->reg_als_rate, &i);
210 if (i < 0 || i >= ARRAY_SIZE(ltr501_als_samp_table))
213 *val = ltr501_als_samp_table[i].freq_val / 1000000;
214 *val2 = ltr501_als_samp_table[i].freq_val % 1000000;
216 return IIO_VAL_INT_PLUS_MICRO;
219 static int ltr501_ps_read_samp_freq(struct ltr501_data *data,
224 ret = regmap_field_read(data->reg_ps_rate, &i);
228 if (i < 0 || i >= ARRAY_SIZE(ltr501_ps_samp_table))
231 *val = ltr501_ps_samp_table[i].freq_val / 1000000;
232 *val2 = ltr501_ps_samp_table[i].freq_val % 1000000;
234 return IIO_VAL_INT_PLUS_MICRO;
237 static int ltr501_als_write_samp_freq(struct ltr501_data *data,
242 i = ltr501_match_samp_freq(ltr501_als_samp_table,
243 ARRAY_SIZE(ltr501_als_samp_table),
249 mutex_lock(&data->lock_als);
250 ret = regmap_field_write(data->reg_als_rate, i);
251 mutex_unlock(&data->lock_als);
256 static int ltr501_ps_write_samp_freq(struct ltr501_data *data,
261 i = ltr501_match_samp_freq(ltr501_ps_samp_table,
262 ARRAY_SIZE(ltr501_ps_samp_table),
268 mutex_lock(&data->lock_ps);
269 ret = regmap_field_write(data->reg_ps_rate, i);
270 mutex_unlock(&data->lock_ps);
275 static int ltr501_als_read_samp_period(struct ltr501_data *data, int *val)
279 ret = regmap_field_read(data->reg_als_rate, &i);
283 if (i < 0 || i >= ARRAY_SIZE(ltr501_als_samp_table))
286 *val = ltr501_als_samp_table[i].time_val;
291 static int ltr501_ps_read_samp_period(struct ltr501_data *data, int *val)
295 ret = regmap_field_read(data->reg_ps_rate, &i);
299 if (i < 0 || i >= ARRAY_SIZE(ltr501_ps_samp_table))
302 *val = ltr501_ps_samp_table[i].time_val;
307 /* IR and visible spectrum coeff's are given in data sheet */
308 static unsigned long ltr501_calculate_lux(u16 vis_data, u16 ir_data)
310 unsigned long ratio, lux;
315 /* multiply numerator by 100 to avoid handling ratio < 1 */
316 ratio = DIV_ROUND_UP(ir_data * 100, ir_data + vis_data);
319 lux = LTR501_LUX_CONV(1774, vis_data, -1105, ir_data);
320 else if (ratio >= 45 && ratio < 64)
321 lux = LTR501_LUX_CONV(3772, vis_data, 1336, ir_data);
322 else if (ratio >= 64 && ratio < 85)
323 lux = LTR501_LUX_CONV(1690, vis_data, 169, ir_data);
330 static int ltr501_drdy(struct ltr501_data *data, u8 drdy_mask)
336 ret = regmap_read(data->regmap, LTR501_ALS_PS_STATUS, &status);
339 if ((status & drdy_mask) == drdy_mask)
344 dev_err(&data->client->dev, "ltr501_drdy() failed, data not ready\n");
348 static int ltr501_set_it_time(struct ltr501_data *data, int it)
350 int ret, i, index = -1, status;
352 for (i = 0; i < ARRAY_SIZE(int_time_mapping); i++) {
353 if (int_time_mapping[i] == it) {
358 /* Make sure integ time index is valid */
362 ret = regmap_read(data->regmap, LTR501_ALS_CONTR, &status);
366 if (status & LTR501_CONTR_ALS_GAIN_MASK) {
368 * 200 ms and 400 ms integ time can only be
369 * used in dynamic range 1
374 /* 50 ms integ time can only be used in dynamic range 2 */
378 return regmap_field_write(data->reg_it, index);
381 /* read int time in micro seconds */
382 static int ltr501_read_it_time(struct ltr501_data *data, int *val, int *val2)
386 ret = regmap_field_read(data->reg_it, &index);
390 /* Make sure integ time index is valid */
391 if (index < 0 || index >= ARRAY_SIZE(int_time_mapping))
394 *val2 = int_time_mapping[index];
397 return IIO_VAL_INT_PLUS_MICRO;
400 static int ltr501_read_als(struct ltr501_data *data, __le16 buf[2])
404 ret = ltr501_drdy(data, LTR501_STATUS_ALS_RDY);
407 /* always read both ALS channels in given order */
408 return regmap_bulk_read(data->regmap, LTR501_ALS_DATA1,
409 buf, 2 * sizeof(__le16));
412 static int ltr501_read_ps(struct ltr501_data *data)
417 ret = ltr501_drdy(data, LTR501_STATUS_PS_RDY);
421 ret = regmap_bulk_read(data->regmap, LTR501_PS_DATA,
422 &status, sizeof(status));
426 return le16_to_cpu(status);
429 static int ltr501_read_intr_prst(struct ltr501_data *data,
430 enum iio_chan_type type,
433 int ret, samp_period, prst;
437 ret = regmap_field_read(data->reg_als_prst, &prst);
441 ret = ltr501_als_read_samp_period(data, &samp_period);
445 *val2 = samp_period * prst;
446 return IIO_VAL_INT_PLUS_MICRO;
448 ret = regmap_field_read(data->reg_ps_prst, &prst);
452 ret = ltr501_ps_read_samp_period(data, &samp_period);
457 *val2 = samp_period * prst;
458 return IIO_VAL_INT_PLUS_MICRO;
466 static int ltr501_write_intr_prst(struct ltr501_data *data,
467 enum iio_chan_type type,
470 int ret, samp_period, new_val;
471 unsigned long period;
473 if (val < 0 || val2 < 0)
476 /* period in microseconds */
477 period = ((val * 1000000) + val2);
481 ret = ltr501_als_read_samp_period(data, &samp_period);
485 /* period should be atleast equal to sampling period */
486 if (period < samp_period)
489 new_val = DIV_ROUND_UP(period, samp_period);
490 if (new_val < 0 || new_val > 0x0f)
493 mutex_lock(&data->lock_als);
494 ret = regmap_field_write(data->reg_als_prst, new_val);
495 mutex_unlock(&data->lock_als);
497 data->als_period = period;
501 ret = ltr501_ps_read_samp_period(data, &samp_period);
505 /* period should be atleast equal to rate */
506 if (period < samp_period)
509 new_val = DIV_ROUND_UP(period, samp_period);
510 if (new_val < 0 || new_val > 0x0f)
513 mutex_lock(&data->lock_ps);
514 ret = regmap_field_write(data->reg_ps_prst, new_val);
515 mutex_unlock(&data->lock_ps);
517 data->ps_period = period;
527 static const struct iio_event_spec ltr501_als_event_spec[] = {
529 .type = IIO_EV_TYPE_THRESH,
530 .dir = IIO_EV_DIR_RISING,
531 .mask_separate = BIT(IIO_EV_INFO_VALUE),
533 .type = IIO_EV_TYPE_THRESH,
534 .dir = IIO_EV_DIR_FALLING,
535 .mask_separate = BIT(IIO_EV_INFO_VALUE),
537 .type = IIO_EV_TYPE_THRESH,
538 .dir = IIO_EV_DIR_EITHER,
539 .mask_separate = BIT(IIO_EV_INFO_ENABLE) |
540 BIT(IIO_EV_INFO_PERIOD),
545 static const struct iio_event_spec ltr501_pxs_event_spec[] = {
547 .type = IIO_EV_TYPE_THRESH,
548 .dir = IIO_EV_DIR_RISING,
549 .mask_separate = BIT(IIO_EV_INFO_VALUE),
551 .type = IIO_EV_TYPE_THRESH,
552 .dir = IIO_EV_DIR_FALLING,
553 .mask_separate = BIT(IIO_EV_INFO_VALUE),
555 .type = IIO_EV_TYPE_THRESH,
556 .dir = IIO_EV_DIR_EITHER,
557 .mask_separate = BIT(IIO_EV_INFO_ENABLE) |
558 BIT(IIO_EV_INFO_PERIOD),
562 #define LTR501_INTENSITY_CHANNEL(_idx, _addr, _mod, _shared, \
563 _evspec, _evsize) { \
564 .type = IIO_INTENSITY, \
566 .address = (_addr), \
567 .channel2 = (_mod), \
568 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
569 .info_mask_shared_by_type = (_shared), \
570 .scan_index = (_idx), \
575 .endianness = IIO_CPU, \
577 .event_spec = _evspec,\
578 .num_event_specs = _evsize,\
581 #define LTR501_LIGHT_CHANNEL() { \
583 .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED), \
587 static const struct iio_chan_spec ltr501_channels[] = {
588 LTR501_LIGHT_CHANNEL(),
589 LTR501_INTENSITY_CHANNEL(0, LTR501_ALS_DATA0, IIO_MOD_LIGHT_BOTH, 0,
590 ltr501_als_event_spec,
591 ARRAY_SIZE(ltr501_als_event_spec)),
592 LTR501_INTENSITY_CHANNEL(1, LTR501_ALS_DATA1, IIO_MOD_LIGHT_IR,
593 BIT(IIO_CHAN_INFO_SCALE) |
594 BIT(IIO_CHAN_INFO_INT_TIME) |
595 BIT(IIO_CHAN_INFO_SAMP_FREQ),
598 .type = IIO_PROXIMITY,
599 .address = LTR501_PS_DATA,
600 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
601 BIT(IIO_CHAN_INFO_SCALE),
607 .endianness = IIO_CPU,
609 .event_spec = ltr501_pxs_event_spec,
610 .num_event_specs = ARRAY_SIZE(ltr501_pxs_event_spec),
612 IIO_CHAN_SOFT_TIMESTAMP(3),
615 static const struct iio_chan_spec ltr301_channels[] = {
616 LTR501_LIGHT_CHANNEL(),
617 LTR501_INTENSITY_CHANNEL(0, LTR501_ALS_DATA0, IIO_MOD_LIGHT_BOTH, 0,
618 ltr501_als_event_spec,
619 ARRAY_SIZE(ltr501_als_event_spec)),
620 LTR501_INTENSITY_CHANNEL(1, LTR501_ALS_DATA1, IIO_MOD_LIGHT_IR,
621 BIT(IIO_CHAN_INFO_SCALE) |
622 BIT(IIO_CHAN_INFO_INT_TIME) |
623 BIT(IIO_CHAN_INFO_SAMP_FREQ),
625 IIO_CHAN_SOFT_TIMESTAMP(2),
628 static int ltr501_read_raw(struct iio_dev *indio_dev,
629 struct iio_chan_spec const *chan,
630 int *val, int *val2, long mask)
632 struct ltr501_data *data = iio_priv(indio_dev);
637 case IIO_CHAN_INFO_PROCESSED:
638 switch (chan->type) {
640 ret = iio_device_claim_direct_mode(indio_dev);
644 mutex_lock(&data->lock_als);
645 ret = ltr501_read_als(data, buf);
646 mutex_unlock(&data->lock_als);
647 iio_device_release_direct_mode(indio_dev);
650 *val = ltr501_calculate_lux(le16_to_cpu(buf[1]),
651 le16_to_cpu(buf[0]));
656 case IIO_CHAN_INFO_RAW:
657 ret = iio_device_claim_direct_mode(indio_dev);
661 switch (chan->type) {
663 mutex_lock(&data->lock_als);
664 ret = ltr501_read_als(data, buf);
665 mutex_unlock(&data->lock_als);
668 *val = le16_to_cpu(chan->address == LTR501_ALS_DATA1 ?
673 mutex_lock(&data->lock_ps);
674 ret = ltr501_read_ps(data);
675 mutex_unlock(&data->lock_ps);
678 *val = ret & LTR501_PS_DATA_MASK;
686 iio_device_release_direct_mode(indio_dev);
689 case IIO_CHAN_INFO_SCALE:
690 switch (chan->type) {
692 i = (data->als_contr & data->chip_info->als_gain_mask)
693 >> data->chip_info->als_gain_shift;
694 *val = data->chip_info->als_gain[i].scale;
695 *val2 = data->chip_info->als_gain[i].uscale;
696 return IIO_VAL_INT_PLUS_MICRO;
698 i = (data->ps_contr & LTR501_CONTR_PS_GAIN_MASK) >>
699 LTR501_CONTR_PS_GAIN_SHIFT;
700 *val = data->chip_info->ps_gain[i].scale;
701 *val2 = data->chip_info->ps_gain[i].uscale;
702 return IIO_VAL_INT_PLUS_MICRO;
706 case IIO_CHAN_INFO_INT_TIME:
707 switch (chan->type) {
709 return ltr501_read_it_time(data, val, val2);
713 case IIO_CHAN_INFO_SAMP_FREQ:
714 switch (chan->type) {
716 return ltr501_als_read_samp_freq(data, val, val2);
718 return ltr501_ps_read_samp_freq(data, val, val2);
726 static int ltr501_get_gain_index(struct ltr501_gain *gain, int size,
731 for (i = 0; i < size; i++)
732 if (val == gain[i].scale && val2 == gain[i].uscale)
738 static int ltr501_write_raw(struct iio_dev *indio_dev,
739 struct iio_chan_spec const *chan,
740 int val, int val2, long mask)
742 struct ltr501_data *data = iio_priv(indio_dev);
743 int i, ret, freq_val, freq_val2;
744 struct ltr501_chip_info *info = data->chip_info;
746 ret = iio_device_claim_direct_mode(indio_dev);
751 case IIO_CHAN_INFO_SCALE:
752 switch (chan->type) {
754 i = ltr501_get_gain_index(info->als_gain,
755 info->als_gain_tbl_size,
762 data->als_contr &= ~info->als_gain_mask;
763 data->als_contr |= i << info->als_gain_shift;
765 ret = regmap_write(data->regmap, LTR501_ALS_CONTR,
769 i = ltr501_get_gain_index(info->ps_gain,
770 info->ps_gain_tbl_size,
776 data->ps_contr &= ~LTR501_CONTR_PS_GAIN_MASK;
777 data->ps_contr |= i << LTR501_CONTR_PS_GAIN_SHIFT;
779 ret = regmap_write(data->regmap, LTR501_PS_CONTR,
788 case IIO_CHAN_INFO_INT_TIME:
789 switch (chan->type) {
795 mutex_lock(&data->lock_als);
796 ret = ltr501_set_it_time(data, val2);
797 mutex_unlock(&data->lock_als);
805 case IIO_CHAN_INFO_SAMP_FREQ:
806 switch (chan->type) {
808 ret = ltr501_als_read_samp_freq(data, &freq_val,
813 ret = ltr501_als_write_samp_freq(data, val, val2);
817 /* update persistence count when changing frequency */
818 ret = ltr501_write_intr_prst(data, chan->type,
819 0, data->als_period);
822 ret = ltr501_als_write_samp_freq(data, freq_val,
826 ret = ltr501_ps_read_samp_freq(data, &freq_val,
831 ret = ltr501_ps_write_samp_freq(data, val, val2);
835 /* update persistence count when changing frequency */
836 ret = ltr501_write_intr_prst(data, chan->type,
840 ret = ltr501_ps_write_samp_freq(data, freq_val,
854 iio_device_release_direct_mode(indio_dev);
858 static int ltr501_read_thresh(struct iio_dev *indio_dev,
859 const struct iio_chan_spec *chan,
860 enum iio_event_type type,
861 enum iio_event_direction dir,
862 enum iio_event_info info,
865 struct ltr501_data *data = iio_priv(indio_dev);
866 int ret, thresh_data;
868 switch (chan->type) {
871 case IIO_EV_DIR_RISING:
872 ret = regmap_bulk_read(data->regmap,
873 LTR501_ALS_THRESH_UP,
877 *val = thresh_data & LTR501_ALS_THRESH_MASK;
879 case IIO_EV_DIR_FALLING:
880 ret = regmap_bulk_read(data->regmap,
881 LTR501_ALS_THRESH_LOW,
885 *val = thresh_data & LTR501_ALS_THRESH_MASK;
892 case IIO_EV_DIR_RISING:
893 ret = regmap_bulk_read(data->regmap,
898 *val = thresh_data & LTR501_PS_THRESH_MASK;
900 case IIO_EV_DIR_FALLING:
901 ret = regmap_bulk_read(data->regmap,
902 LTR501_PS_THRESH_LOW,
906 *val = thresh_data & LTR501_PS_THRESH_MASK;
918 static int ltr501_write_thresh(struct iio_dev *indio_dev,
919 const struct iio_chan_spec *chan,
920 enum iio_event_type type,
921 enum iio_event_direction dir,
922 enum iio_event_info info,
925 struct ltr501_data *data = iio_priv(indio_dev);
931 switch (chan->type) {
933 if (val > LTR501_ALS_THRESH_MASK)
936 case IIO_EV_DIR_RISING:
937 mutex_lock(&data->lock_als);
938 ret = regmap_bulk_write(data->regmap,
939 LTR501_ALS_THRESH_UP,
941 mutex_unlock(&data->lock_als);
943 case IIO_EV_DIR_FALLING:
944 mutex_lock(&data->lock_als);
945 ret = regmap_bulk_write(data->regmap,
946 LTR501_ALS_THRESH_LOW,
948 mutex_unlock(&data->lock_als);
954 if (val > LTR501_PS_THRESH_MASK)
957 case IIO_EV_DIR_RISING:
958 mutex_lock(&data->lock_ps);
959 ret = regmap_bulk_write(data->regmap,
962 mutex_unlock(&data->lock_ps);
964 case IIO_EV_DIR_FALLING:
965 mutex_lock(&data->lock_ps);
966 ret = regmap_bulk_write(data->regmap,
967 LTR501_PS_THRESH_LOW,
969 mutex_unlock(&data->lock_ps);
981 static int ltr501_read_event(struct iio_dev *indio_dev,
982 const struct iio_chan_spec *chan,
983 enum iio_event_type type,
984 enum iio_event_direction dir,
985 enum iio_event_info info,
991 case IIO_EV_INFO_VALUE:
992 return ltr501_read_thresh(indio_dev, chan, type, dir,
994 case IIO_EV_INFO_PERIOD:
995 ret = ltr501_read_intr_prst(iio_priv(indio_dev),
997 *val = *val2 / 1000000;
998 *val2 = *val2 % 1000000;
1007 static int ltr501_write_event(struct iio_dev *indio_dev,
1008 const struct iio_chan_spec *chan,
1009 enum iio_event_type type,
1010 enum iio_event_direction dir,
1011 enum iio_event_info info,
1015 case IIO_EV_INFO_VALUE:
1018 return ltr501_write_thresh(indio_dev, chan, type, dir,
1020 case IIO_EV_INFO_PERIOD:
1021 return ltr501_write_intr_prst(iio_priv(indio_dev), chan->type,
1030 static int ltr501_read_event_config(struct iio_dev *indio_dev,
1031 const struct iio_chan_spec *chan,
1032 enum iio_event_type type,
1033 enum iio_event_direction dir)
1035 struct ltr501_data *data = iio_priv(indio_dev);
1038 switch (chan->type) {
1040 ret = regmap_field_read(data->reg_als_intr, &status);
1045 ret = regmap_field_read(data->reg_ps_intr, &status);
1056 static int ltr501_write_event_config(struct iio_dev *indio_dev,
1057 const struct iio_chan_spec *chan,
1058 enum iio_event_type type,
1059 enum iio_event_direction dir, int state)
1061 struct ltr501_data *data = iio_priv(indio_dev);
1064 /* only 1 and 0 are valid inputs */
1065 if (state != 1 && state != 0)
1068 switch (chan->type) {
1070 mutex_lock(&data->lock_als);
1071 ret = regmap_field_write(data->reg_als_intr, state);
1072 mutex_unlock(&data->lock_als);
1075 mutex_lock(&data->lock_ps);
1076 ret = regmap_field_write(data->reg_ps_intr, state);
1077 mutex_unlock(&data->lock_ps);
1086 static ssize_t ltr501_show_proximity_scale_avail(struct device *dev,
1087 struct device_attribute *attr,
1090 struct ltr501_data *data = iio_priv(dev_to_iio_dev(dev));
1091 struct ltr501_chip_info *info = data->chip_info;
1095 for (i = 0; i < info->ps_gain_tbl_size; i++) {
1096 if (info->ps_gain[i].scale == LTR501_RESERVED_GAIN)
1098 len += scnprintf(buf + len, PAGE_SIZE - len, "%d.%06d ",
1099 info->ps_gain[i].scale,
1100 info->ps_gain[i].uscale);
1103 buf[len - 1] = '\n';
1108 static ssize_t ltr501_show_intensity_scale_avail(struct device *dev,
1109 struct device_attribute *attr,
1112 struct ltr501_data *data = iio_priv(dev_to_iio_dev(dev));
1113 struct ltr501_chip_info *info = data->chip_info;
1117 for (i = 0; i < info->als_gain_tbl_size; i++) {
1118 if (info->als_gain[i].scale == LTR501_RESERVED_GAIN)
1120 len += scnprintf(buf + len, PAGE_SIZE - len, "%d.%06d ",
1121 info->als_gain[i].scale,
1122 info->als_gain[i].uscale);
1125 buf[len - 1] = '\n';
1130 static IIO_CONST_ATTR_INT_TIME_AVAIL("0.05 0.1 0.2 0.4");
1131 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("20 10 5 2 1 0.5");
1133 static IIO_DEVICE_ATTR(in_proximity_scale_available, S_IRUGO,
1134 ltr501_show_proximity_scale_avail, NULL, 0);
1135 static IIO_DEVICE_ATTR(in_intensity_scale_available, S_IRUGO,
1136 ltr501_show_intensity_scale_avail, NULL, 0);
1138 static struct attribute *ltr501_attributes[] = {
1139 &iio_dev_attr_in_proximity_scale_available.dev_attr.attr,
1140 &iio_dev_attr_in_intensity_scale_available.dev_attr.attr,
1141 &iio_const_attr_integration_time_available.dev_attr.attr,
1142 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
1146 static struct attribute *ltr301_attributes[] = {
1147 &iio_dev_attr_in_intensity_scale_available.dev_attr.attr,
1148 &iio_const_attr_integration_time_available.dev_attr.attr,
1149 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
1153 static const struct attribute_group ltr501_attribute_group = {
1154 .attrs = ltr501_attributes,
1157 static const struct attribute_group ltr301_attribute_group = {
1158 .attrs = ltr301_attributes,
1161 static const struct iio_info ltr501_info_no_irq = {
1162 .read_raw = ltr501_read_raw,
1163 .write_raw = ltr501_write_raw,
1164 .attrs = <r501_attribute_group,
1167 static const struct iio_info ltr501_info = {
1168 .read_raw = ltr501_read_raw,
1169 .write_raw = ltr501_write_raw,
1170 .attrs = <r501_attribute_group,
1171 .read_event_value = <r501_read_event,
1172 .write_event_value = <r501_write_event,
1173 .read_event_config = <r501_read_event_config,
1174 .write_event_config = <r501_write_event_config,
1177 static const struct iio_info ltr301_info_no_irq = {
1178 .read_raw = ltr501_read_raw,
1179 .write_raw = ltr501_write_raw,
1180 .attrs = <r301_attribute_group,
1183 static const struct iio_info ltr301_info = {
1184 .read_raw = ltr501_read_raw,
1185 .write_raw = ltr501_write_raw,
1186 .attrs = <r301_attribute_group,
1187 .read_event_value = <r501_read_event,
1188 .write_event_value = <r501_write_event,
1189 .read_event_config = <r501_read_event_config,
1190 .write_event_config = <r501_write_event_config,
1193 static struct ltr501_chip_info ltr501_chip_info_tbl[] = {
1196 .als_gain = ltr501_als_gain_tbl,
1197 .als_gain_tbl_size = ARRAY_SIZE(ltr501_als_gain_tbl),
1198 .ps_gain = ltr501_ps_gain_tbl,
1199 .ps_gain_tbl_size = ARRAY_SIZE(ltr501_ps_gain_tbl),
1200 .als_mode_active = BIT(0) | BIT(1),
1201 .als_gain_mask = BIT(3),
1202 .als_gain_shift = 3,
1203 .info = <r501_info,
1204 .info_no_irq = <r501_info_no_irq,
1205 .channels = ltr501_channels,
1206 .no_channels = ARRAY_SIZE(ltr501_channels),
1210 .als_gain = ltr559_als_gain_tbl,
1211 .als_gain_tbl_size = ARRAY_SIZE(ltr559_als_gain_tbl),
1212 .ps_gain = ltr559_ps_gain_tbl,
1213 .ps_gain_tbl_size = ARRAY_SIZE(ltr559_ps_gain_tbl),
1214 .als_mode_active = BIT(0),
1215 .als_gain_mask = BIT(2) | BIT(3) | BIT(4),
1216 .als_gain_shift = 2,
1217 .info = <r501_info,
1218 .info_no_irq = <r501_info_no_irq,
1219 .channels = ltr501_channels,
1220 .no_channels = ARRAY_SIZE(ltr501_channels),
1224 .als_gain = ltr501_als_gain_tbl,
1225 .als_gain_tbl_size = ARRAY_SIZE(ltr501_als_gain_tbl),
1226 .als_mode_active = BIT(0) | BIT(1),
1227 .als_gain_mask = BIT(3),
1228 .als_gain_shift = 3,
1229 .info = <r301_info,
1230 .info_no_irq = <r301_info_no_irq,
1231 .channels = ltr301_channels,
1232 .no_channels = ARRAY_SIZE(ltr301_channels),
1236 static int ltr501_write_contr(struct ltr501_data *data, u8 als_val, u8 ps_val)
1240 ret = regmap_write(data->regmap, LTR501_ALS_CONTR, als_val);
1244 return regmap_write(data->regmap, LTR501_PS_CONTR, ps_val);
1247 static irqreturn_t ltr501_trigger_handler(int irq, void *p)
1249 struct iio_poll_func *pf = p;
1250 struct iio_dev *indio_dev = pf->indio_dev;
1251 struct ltr501_data *data = iio_priv(indio_dev);
1254 s64 ts __aligned(8);
1261 memset(&scan, 0, sizeof(scan));
1263 /* figure out which data needs to be ready */
1264 if (test_bit(0, indio_dev->active_scan_mask) ||
1265 test_bit(1, indio_dev->active_scan_mask))
1266 mask |= LTR501_STATUS_ALS_RDY;
1267 if (test_bit(2, indio_dev->active_scan_mask))
1268 mask |= LTR501_STATUS_PS_RDY;
1270 ret = ltr501_drdy(data, mask);
1274 if (mask & LTR501_STATUS_ALS_RDY) {
1275 ret = regmap_bulk_read(data->regmap, LTR501_ALS_DATA1,
1276 (u8 *)als_buf, sizeof(als_buf));
1279 if (test_bit(0, indio_dev->active_scan_mask))
1280 scan.channels[j++] = le16_to_cpu(als_buf[1]);
1281 if (test_bit(1, indio_dev->active_scan_mask))
1282 scan.channels[j++] = le16_to_cpu(als_buf[0]);
1285 if (mask & LTR501_STATUS_PS_RDY) {
1286 ret = regmap_bulk_read(data->regmap, LTR501_PS_DATA,
1290 scan.channels[j++] = psdata & LTR501_PS_DATA_MASK;
1293 iio_push_to_buffers_with_timestamp(indio_dev, &scan,
1294 iio_get_time_ns(indio_dev));
1297 iio_trigger_notify_done(indio_dev->trig);
1302 static irqreturn_t ltr501_interrupt_handler(int irq, void *private)
1304 struct iio_dev *indio_dev = private;
1305 struct ltr501_data *data = iio_priv(indio_dev);
1308 ret = regmap_read(data->regmap, LTR501_ALS_PS_STATUS, &status);
1310 dev_err(&data->client->dev,
1311 "irq read int reg failed\n");
1315 if (status & LTR501_STATUS_ALS_INTR)
1316 iio_push_event(indio_dev,
1317 IIO_UNMOD_EVENT_CODE(IIO_INTENSITY, 0,
1320 iio_get_time_ns(indio_dev));
1322 if (status & LTR501_STATUS_PS_INTR)
1323 iio_push_event(indio_dev,
1324 IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
1327 iio_get_time_ns(indio_dev));
1332 static int ltr501_init(struct ltr501_data *data)
1336 ret = regmap_read(data->regmap, LTR501_ALS_CONTR, &status);
1340 data->als_contr = status | data->chip_info->als_mode_active;
1342 ret = regmap_read(data->regmap, LTR501_PS_CONTR, &status);
1346 data->ps_contr = status | LTR501_CONTR_ACTIVE;
1348 ret = ltr501_read_intr_prst(data, IIO_INTENSITY, &data->als_period);
1352 ret = ltr501_read_intr_prst(data, IIO_PROXIMITY, &data->ps_period);
1356 return ltr501_write_contr(data, data->als_contr, data->ps_contr);
1359 static bool ltr501_is_volatile_reg(struct device *dev, unsigned int reg)
1362 case LTR501_ALS_DATA1:
1363 case LTR501_ALS_DATA1_UPPER:
1364 case LTR501_ALS_DATA0:
1365 case LTR501_ALS_DATA0_UPPER:
1366 case LTR501_ALS_PS_STATUS:
1367 case LTR501_PS_DATA:
1368 case LTR501_PS_DATA_UPPER:
1375 static struct regmap_config ltr501_regmap_config = {
1376 .name = LTR501_REGMAP_NAME,
1379 .max_register = LTR501_MAX_REG,
1380 .cache_type = REGCACHE_RBTREE,
1381 .volatile_reg = ltr501_is_volatile_reg,
1384 static int ltr501_powerdown(struct ltr501_data *data)
1386 return ltr501_write_contr(data, data->als_contr &
1387 ~data->chip_info->als_mode_active,
1388 data->ps_contr & ~LTR501_CONTR_ACTIVE);
1391 static const char *ltr501_match_acpi_device(struct device *dev, int *chip_idx)
1393 const struct acpi_device_id *id;
1395 id = acpi_match_device(dev->driver->acpi_match_table, dev);
1398 *chip_idx = id->driver_data;
1399 return dev_name(dev);
1402 static int ltr501_probe(struct i2c_client *client,
1403 const struct i2c_device_id *id)
1405 struct ltr501_data *data;
1406 struct iio_dev *indio_dev;
1407 struct regmap *regmap;
1408 int ret, partid, chip_idx = 0;
1409 const char *name = NULL;
1411 indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
1415 regmap = devm_regmap_init_i2c(client, <r501_regmap_config);
1416 if (IS_ERR(regmap)) {
1417 dev_err(&client->dev, "Regmap initialization failed.\n");
1418 return PTR_ERR(regmap);
1421 data = iio_priv(indio_dev);
1422 i2c_set_clientdata(client, indio_dev);
1423 data->client = client;
1424 data->regmap = regmap;
1425 mutex_init(&data->lock_als);
1426 mutex_init(&data->lock_ps);
1428 data->reg_it = devm_regmap_field_alloc(&client->dev, regmap,
1430 if (IS_ERR(data->reg_it)) {
1431 dev_err(&client->dev, "Integ time reg field init failed.\n");
1432 return PTR_ERR(data->reg_it);
1435 data->reg_als_intr = devm_regmap_field_alloc(&client->dev, regmap,
1436 reg_field_als_intr);
1437 if (IS_ERR(data->reg_als_intr)) {
1438 dev_err(&client->dev, "ALS intr mode reg field init failed\n");
1439 return PTR_ERR(data->reg_als_intr);
1442 data->reg_ps_intr = devm_regmap_field_alloc(&client->dev, regmap,
1444 if (IS_ERR(data->reg_ps_intr)) {
1445 dev_err(&client->dev, "PS intr mode reg field init failed.\n");
1446 return PTR_ERR(data->reg_ps_intr);
1449 data->reg_als_rate = devm_regmap_field_alloc(&client->dev, regmap,
1450 reg_field_als_rate);
1451 if (IS_ERR(data->reg_als_rate)) {
1452 dev_err(&client->dev, "ALS samp rate field init failed.\n");
1453 return PTR_ERR(data->reg_als_rate);
1456 data->reg_ps_rate = devm_regmap_field_alloc(&client->dev, regmap,
1458 if (IS_ERR(data->reg_ps_rate)) {
1459 dev_err(&client->dev, "PS samp rate field init failed.\n");
1460 return PTR_ERR(data->reg_ps_rate);
1463 data->reg_als_prst = devm_regmap_field_alloc(&client->dev, regmap,
1464 reg_field_als_prst);
1465 if (IS_ERR(data->reg_als_prst)) {
1466 dev_err(&client->dev, "ALS prst reg field init failed\n");
1467 return PTR_ERR(data->reg_als_prst);
1470 data->reg_ps_prst = devm_regmap_field_alloc(&client->dev, regmap,
1472 if (IS_ERR(data->reg_ps_prst)) {
1473 dev_err(&client->dev, "PS prst reg field init failed.\n");
1474 return PTR_ERR(data->reg_ps_prst);
1477 ret = regmap_read(data->regmap, LTR501_PART_ID, &partid);
1483 chip_idx = id->driver_data;
1484 } else if (ACPI_HANDLE(&client->dev)) {
1485 name = ltr501_match_acpi_device(&client->dev, &chip_idx);
1490 data->chip_info = <r501_chip_info_tbl[chip_idx];
1492 if ((partid >> 4) != data->chip_info->partid)
1495 indio_dev->dev.parent = &client->dev;
1496 indio_dev->info = data->chip_info->info;
1497 indio_dev->channels = data->chip_info->channels;
1498 indio_dev->num_channels = data->chip_info->no_channels;
1499 indio_dev->name = name;
1500 indio_dev->modes = INDIO_DIRECT_MODE;
1502 ret = ltr501_init(data);
1506 if (client->irq > 0) {
1507 ret = devm_request_threaded_irq(&client->dev, client->irq,
1508 NULL, ltr501_interrupt_handler,
1509 IRQF_TRIGGER_FALLING |
1511 "ltr501_thresh_event",
1514 dev_err(&client->dev, "request irq (%d) failed\n",
1519 indio_dev->info = data->chip_info->info_no_irq;
1522 ret = iio_triggered_buffer_setup(indio_dev, NULL,
1523 ltr501_trigger_handler, NULL);
1525 goto powerdown_on_error;
1527 ret = iio_device_register(indio_dev);
1529 goto error_unreg_buffer;
1534 iio_triggered_buffer_cleanup(indio_dev);
1536 ltr501_powerdown(data);
1540 static int ltr501_remove(struct i2c_client *client)
1542 struct iio_dev *indio_dev = i2c_get_clientdata(client);
1544 iio_device_unregister(indio_dev);
1545 iio_triggered_buffer_cleanup(indio_dev);
1546 ltr501_powerdown(iio_priv(indio_dev));
1551 #ifdef CONFIG_PM_SLEEP
1552 static int ltr501_suspend(struct device *dev)
1554 struct ltr501_data *data = iio_priv(i2c_get_clientdata(
1555 to_i2c_client(dev)));
1556 return ltr501_powerdown(data);
1559 static int ltr501_resume(struct device *dev)
1561 struct ltr501_data *data = iio_priv(i2c_get_clientdata(
1562 to_i2c_client(dev)));
1564 return ltr501_write_contr(data, data->als_contr,
1569 static SIMPLE_DEV_PM_OPS(ltr501_pm_ops, ltr501_suspend, ltr501_resume);
1571 static const struct acpi_device_id ltr_acpi_match[] = {
1572 {"LTER0501", ltr501},
1573 {"LTER0559", ltr559},
1574 {"LTER0301", ltr301},
1577 MODULE_DEVICE_TABLE(acpi, ltr_acpi_match);
1579 static const struct i2c_device_id ltr501_id[] = {
1580 { "ltr501", ltr501},
1581 { "ltr559", ltr559},
1582 { "ltr301", ltr301},
1585 MODULE_DEVICE_TABLE(i2c, ltr501_id);
1587 static struct i2c_driver ltr501_driver = {
1589 .name = LTR501_DRV_NAME,
1590 .pm = <r501_pm_ops,
1591 .acpi_match_table = ACPI_PTR(ltr_acpi_match),
1593 .probe = ltr501_probe,
1594 .remove = ltr501_remove,
1595 .id_table = ltr501_id,
1598 module_i2c_driver(ltr501_driver);
1600 MODULE_AUTHOR("Peter Meerwald <pmeerw@pmeerw.net>");
1601 MODULE_DESCRIPTION("Lite-On LTR501 ambient light and proximity sensor driver");
1602 MODULE_LICENSE("GPL");