2 * Sensortek STK3310/STK3311 Ambient Light and Proximity Sensor
4 * Copyright (c) 2015, Intel Corporation.
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 * IIO driver for STK3310/STK3311. 7-bit I2C address: 0x48.
13 #include <linux/acpi.h>
14 #include <linux/i2c.h>
15 #include <linux/interrupt.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/regmap.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/iio/events.h>
21 #include <linux/iio/iio.h>
22 #include <linux/iio/sysfs.h>
24 #define STK3310_REG_STATE 0x00
25 #define STK3310_REG_PSCTRL 0x01
26 #define STK3310_REG_ALSCTRL 0x02
27 #define STK3310_REG_INT 0x04
28 #define STK3310_REG_THDH_PS 0x06
29 #define STK3310_REG_THDL_PS 0x08
30 #define STK3310_REG_FLAG 0x10
31 #define STK3310_REG_PS_DATA_MSB 0x11
32 #define STK3310_REG_PS_DATA_LSB 0x12
33 #define STK3310_REG_ALS_DATA_MSB 0x13
34 #define STK3310_REG_ALS_DATA_LSB 0x14
35 #define STK3310_REG_ID 0x3E
36 #define STK3310_MAX_REG 0x80
38 #define STK3310_STATE_EN_PS BIT(0)
39 #define STK3310_STATE_EN_ALS BIT(1)
40 #define STK3310_STATE_STANDBY 0x00
42 #define STK3310_CHIP_ID_VAL 0x13
43 #define STK3311_CHIP_ID_VAL 0x1D
44 #define STK3310_PSINT_EN 0x01
45 #define STK3310_PS_MAX_VAL 0xFFFF
47 #define STK3310_DRIVER_NAME "stk3310"
48 #define STK3310_REGMAP_NAME "stk3310_regmap"
49 #define STK3310_EVENT "stk3310_event"
51 #define STK3310_SCALE_AVAILABLE "6.4 1.6 0.4 0.1"
53 #define STK3310_IT_AVAILABLE \
54 "0.000185 0.000370 0.000741 0.001480 0.002960 0.005920 0.011840 " \
55 "0.023680 0.047360 0.094720 0.189440 0.378880 0.757760 1.515520 " \
58 #define STK3310_REGFIELD(name) \
61 devm_regmap_field_alloc(&client->dev, regmap, \
62 stk3310_reg_field_##name); \
63 if (IS_ERR(data->reg_##name)) { \
64 dev_err(&client->dev, "reg field alloc failed.\n"); \
65 return PTR_ERR(data->reg_##name); \
69 static const struct reg_field stk3310_reg_field_state
=
70 REG_FIELD(STK3310_REG_STATE
, 0, 2);
71 static const struct reg_field stk3310_reg_field_als_gain
=
72 REG_FIELD(STK3310_REG_ALSCTRL
, 4, 5);
73 static const struct reg_field stk3310_reg_field_ps_gain
=
74 REG_FIELD(STK3310_REG_PSCTRL
, 4, 5);
75 static const struct reg_field stk3310_reg_field_als_it
=
76 REG_FIELD(STK3310_REG_ALSCTRL
, 0, 3);
77 static const struct reg_field stk3310_reg_field_ps_it
=
78 REG_FIELD(STK3310_REG_PSCTRL
, 0, 3);
79 static const struct reg_field stk3310_reg_field_int_ps
=
80 REG_FIELD(STK3310_REG_INT
, 0, 2);
81 static const struct reg_field stk3310_reg_field_flag_psint
=
82 REG_FIELD(STK3310_REG_FLAG
, 4, 4);
83 static const struct reg_field stk3310_reg_field_flag_nf
=
84 REG_FIELD(STK3310_REG_FLAG
, 0, 0);
86 /* Estimate maximum proximity values with regard to measurement scale. */
87 static const int stk3310_ps_max
[4] = {
88 STK3310_PS_MAX_VAL
/ 640,
89 STK3310_PS_MAX_VAL
/ 160,
90 STK3310_PS_MAX_VAL
/ 40,
91 STK3310_PS_MAX_VAL
/ 10
94 static const int stk3310_scale_table
[][2] = {
95 {6, 400000}, {1, 600000}, {0, 400000}, {0, 100000}
98 /* Integration time in seconds, microseconds */
99 static const int stk3310_it_table
[][2] = {
100 {0, 185}, {0, 370}, {0, 741}, {0, 1480},
101 {0, 2960}, {0, 5920}, {0, 11840}, {0, 23680},
102 {0, 47360}, {0, 94720}, {0, 189440}, {0, 378880},
103 {0, 757760}, {1, 515520}, {3, 31040}, {6, 62080},
106 struct stk3310_data
{
107 struct i2c_client
*client
;
112 struct regmap
*regmap
;
113 struct regmap_field
*reg_state
;
114 struct regmap_field
*reg_als_gain
;
115 struct regmap_field
*reg_ps_gain
;
116 struct regmap_field
*reg_als_it
;
117 struct regmap_field
*reg_ps_it
;
118 struct regmap_field
*reg_int_ps
;
119 struct regmap_field
*reg_flag_psint
;
120 struct regmap_field
*reg_flag_nf
;
123 static const struct iio_event_spec stk3310_events
[] = {
124 /* Proximity event */
126 .type
= IIO_EV_TYPE_THRESH
,
127 .dir
= IIO_EV_DIR_RISING
,
128 .mask_separate
= BIT(IIO_EV_INFO_VALUE
) |
129 BIT(IIO_EV_INFO_ENABLE
),
131 /* Out-of-proximity event */
133 .type
= IIO_EV_TYPE_THRESH
,
134 .dir
= IIO_EV_DIR_FALLING
,
135 .mask_separate
= BIT(IIO_EV_INFO_VALUE
) |
136 BIT(IIO_EV_INFO_ENABLE
),
140 static const struct iio_chan_spec stk3310_channels
[] = {
143 .info_mask_separate
=
144 BIT(IIO_CHAN_INFO_RAW
) |
145 BIT(IIO_CHAN_INFO_SCALE
) |
146 BIT(IIO_CHAN_INFO_INT_TIME
),
149 .type
= IIO_PROXIMITY
,
150 .info_mask_separate
=
151 BIT(IIO_CHAN_INFO_RAW
) |
152 BIT(IIO_CHAN_INFO_SCALE
) |
153 BIT(IIO_CHAN_INFO_INT_TIME
),
154 .event_spec
= stk3310_events
,
155 .num_event_specs
= ARRAY_SIZE(stk3310_events
),
159 static IIO_CONST_ATTR(in_illuminance_scale_available
, STK3310_SCALE_AVAILABLE
);
161 static IIO_CONST_ATTR(in_proximity_scale_available
, STK3310_SCALE_AVAILABLE
);
163 static IIO_CONST_ATTR(in_illuminance_integration_time_available
,
164 STK3310_IT_AVAILABLE
);
166 static IIO_CONST_ATTR(in_proximity_integration_time_available
,
167 STK3310_IT_AVAILABLE
);
169 static struct attribute
*stk3310_attributes
[] = {
170 &iio_const_attr_in_illuminance_scale_available
.dev_attr
.attr
,
171 &iio_const_attr_in_proximity_scale_available
.dev_attr
.attr
,
172 &iio_const_attr_in_illuminance_integration_time_available
.dev_attr
.attr
,
173 &iio_const_attr_in_proximity_integration_time_available
.dev_attr
.attr
,
177 static const struct attribute_group stk3310_attribute_group
= {
178 .attrs
= stk3310_attributes
181 static int stk3310_get_index(const int table
[][2], int table_size
,
186 for (i
= 0; i
< table_size
; i
++) {
187 if (val
== table
[i
][0] && val2
== table
[i
][1])
194 static int stk3310_read_event(struct iio_dev
*indio_dev
,
195 const struct iio_chan_spec
*chan
,
196 enum iio_event_type type
,
197 enum iio_event_direction dir
,
198 enum iio_event_info info
,
204 struct stk3310_data
*data
= iio_priv(indio_dev
);
206 if (info
!= IIO_EV_INFO_VALUE
)
209 /* Only proximity interrupts are implemented at the moment. */
210 if (dir
== IIO_EV_DIR_RISING
)
211 reg
= STK3310_REG_THDH_PS
;
212 else if (dir
== IIO_EV_DIR_FALLING
)
213 reg
= STK3310_REG_THDL_PS
;
217 mutex_lock(&data
->lock
);
218 ret
= regmap_bulk_read(data
->regmap
, reg
, &buf
, 2);
219 mutex_unlock(&data
->lock
);
221 dev_err(&data
->client
->dev
, "register read failed\n");
224 *val
= be16_to_cpu(buf
);
229 static int stk3310_write_event(struct iio_dev
*indio_dev
,
230 const struct iio_chan_spec
*chan
,
231 enum iio_event_type type
,
232 enum iio_event_direction dir
,
233 enum iio_event_info info
,
240 struct stk3310_data
*data
= iio_priv(indio_dev
);
241 struct i2c_client
*client
= data
->client
;
243 ret
= regmap_field_read(data
->reg_ps_gain
, &index
);
247 if (val
< 0 || val
> stk3310_ps_max
[index
])
250 if (dir
== IIO_EV_DIR_RISING
)
251 reg
= STK3310_REG_THDH_PS
;
252 else if (dir
== IIO_EV_DIR_FALLING
)
253 reg
= STK3310_REG_THDL_PS
;
257 buf
= cpu_to_be16(val
);
258 ret
= regmap_bulk_write(data
->regmap
, reg
, &buf
, 2);
260 dev_err(&client
->dev
, "failed to set PS threshold!\n");
265 static int stk3310_read_event_config(struct iio_dev
*indio_dev
,
266 const struct iio_chan_spec
*chan
,
267 enum iio_event_type type
,
268 enum iio_event_direction dir
)
270 unsigned int event_val
;
272 struct stk3310_data
*data
= iio_priv(indio_dev
);
274 ret
= regmap_field_read(data
->reg_int_ps
, &event_val
);
281 static int stk3310_write_event_config(struct iio_dev
*indio_dev
,
282 const struct iio_chan_spec
*chan
,
283 enum iio_event_type type
,
284 enum iio_event_direction dir
,
288 struct stk3310_data
*data
= iio_priv(indio_dev
);
289 struct i2c_client
*client
= data
->client
;
291 if (state
< 0 || state
> 7)
294 /* Set INT_PS value */
295 mutex_lock(&data
->lock
);
296 ret
= regmap_field_write(data
->reg_int_ps
, state
);
298 dev_err(&client
->dev
, "failed to set interrupt mode\n");
299 mutex_unlock(&data
->lock
);
304 static int stk3310_read_raw(struct iio_dev
*indio_dev
,
305 struct iio_chan_spec
const *chan
,
306 int *val
, int *val2
, long mask
)
312 struct stk3310_data
*data
= iio_priv(indio_dev
);
313 struct i2c_client
*client
= data
->client
;
315 if (chan
->type
!= IIO_LIGHT
&& chan
->type
!= IIO_PROXIMITY
)
319 case IIO_CHAN_INFO_RAW
:
320 if (chan
->type
== IIO_LIGHT
)
321 reg
= STK3310_REG_ALS_DATA_MSB
;
323 reg
= STK3310_REG_PS_DATA_MSB
;
325 mutex_lock(&data
->lock
);
326 ret
= regmap_bulk_read(data
->regmap
, reg
, &buf
, 2);
328 dev_err(&client
->dev
, "register read failed\n");
329 mutex_unlock(&data
->lock
);
332 *val
= be16_to_cpu(buf
);
333 mutex_unlock(&data
->lock
);
335 case IIO_CHAN_INFO_INT_TIME
:
336 if (chan
->type
== IIO_LIGHT
)
337 ret
= regmap_field_read(data
->reg_als_it
, &index
);
339 ret
= regmap_field_read(data
->reg_ps_it
, &index
);
343 *val
= stk3310_it_table
[index
][0];
344 *val2
= stk3310_it_table
[index
][1];
345 return IIO_VAL_INT_PLUS_MICRO
;
346 case IIO_CHAN_INFO_SCALE
:
347 if (chan
->type
== IIO_LIGHT
)
348 ret
= regmap_field_read(data
->reg_als_gain
, &index
);
350 ret
= regmap_field_read(data
->reg_ps_gain
, &index
);
354 *val
= stk3310_scale_table
[index
][0];
355 *val2
= stk3310_scale_table
[index
][1];
356 return IIO_VAL_INT_PLUS_MICRO
;
362 static int stk3310_write_raw(struct iio_dev
*indio_dev
,
363 struct iio_chan_spec
const *chan
,
364 int val
, int val2
, long mask
)
368 struct stk3310_data
*data
= iio_priv(indio_dev
);
370 if (chan
->type
!= IIO_LIGHT
&& chan
->type
!= IIO_PROXIMITY
)
374 case IIO_CHAN_INFO_INT_TIME
:
375 index
= stk3310_get_index(stk3310_it_table
,
376 ARRAY_SIZE(stk3310_it_table
),
380 mutex_lock(&data
->lock
);
381 if (chan
->type
== IIO_LIGHT
)
382 ret
= regmap_field_write(data
->reg_als_it
, index
);
384 ret
= regmap_field_write(data
->reg_ps_it
, index
);
386 dev_err(&data
->client
->dev
,
387 "sensor configuration failed\n");
388 mutex_unlock(&data
->lock
);
391 case IIO_CHAN_INFO_SCALE
:
392 index
= stk3310_get_index(stk3310_scale_table
,
393 ARRAY_SIZE(stk3310_scale_table
),
397 mutex_lock(&data
->lock
);
398 if (chan
->type
== IIO_LIGHT
)
399 ret
= regmap_field_write(data
->reg_als_gain
, index
);
401 ret
= regmap_field_write(data
->reg_ps_gain
, index
);
403 dev_err(&data
->client
->dev
,
404 "sensor configuration failed\n");
405 mutex_unlock(&data
->lock
);
412 static const struct iio_info stk3310_info
= {
413 .driver_module
= THIS_MODULE
,
414 .read_raw
= stk3310_read_raw
,
415 .write_raw
= stk3310_write_raw
,
416 .attrs
= &stk3310_attribute_group
,
417 .read_event_value
= stk3310_read_event
,
418 .write_event_value
= stk3310_write_event
,
419 .read_event_config
= stk3310_read_event_config
,
420 .write_event_config
= stk3310_write_event_config
,
423 static int stk3310_set_state(struct stk3310_data
*data
, u8 state
)
426 struct i2c_client
*client
= data
->client
;
428 /* 3-bit state; 0b100 is not supported. */
429 if (state
> 7 || state
== 4)
432 mutex_lock(&data
->lock
);
433 ret
= regmap_field_write(data
->reg_state
, state
);
435 dev_err(&client
->dev
, "failed to change sensor state\n");
436 } else if (state
!= STK3310_STATE_STANDBY
) {
437 /* Don't reset the 'enabled' flags if we're going in standby */
438 data
->ps_enabled
= !!(state
& STK3310_STATE_EN_PS
);
439 data
->als_enabled
= !!(state
& STK3310_STATE_EN_ALS
);
441 mutex_unlock(&data
->lock
);
446 static int stk3310_init(struct iio_dev
*indio_dev
)
451 struct stk3310_data
*data
= iio_priv(indio_dev
);
452 struct i2c_client
*client
= data
->client
;
454 ret
= regmap_read(data
->regmap
, STK3310_REG_ID
, &chipid
);
458 if (chipid
!= STK3310_CHIP_ID_VAL
&&
459 chipid
!= STK3311_CHIP_ID_VAL
) {
460 dev_err(&client
->dev
, "invalid chip id: 0x%x\n", chipid
);
464 state
= STK3310_STATE_EN_ALS
| STK3310_STATE_EN_PS
;
465 ret
= stk3310_set_state(data
, state
);
467 dev_err(&client
->dev
, "failed to enable sensor");
471 /* Enable PS interrupts */
472 ret
= regmap_field_write(data
->reg_int_ps
, STK3310_PSINT_EN
);
474 dev_err(&client
->dev
, "failed to enable interrupts!\n");
479 static bool stk3310_is_volatile_reg(struct device
*dev
, unsigned int reg
)
482 case STK3310_REG_ALS_DATA_MSB
:
483 case STK3310_REG_ALS_DATA_LSB
:
484 case STK3310_REG_PS_DATA_LSB
:
485 case STK3310_REG_PS_DATA_MSB
:
486 case STK3310_REG_FLAG
:
493 static struct regmap_config stk3310_regmap_config
= {
494 .name
= STK3310_REGMAP_NAME
,
497 .max_register
= STK3310_MAX_REG
,
498 .cache_type
= REGCACHE_RBTREE
,
499 .volatile_reg
= stk3310_is_volatile_reg
,
502 static int stk3310_regmap_init(struct stk3310_data
*data
)
504 struct regmap
*regmap
;
505 struct i2c_client
*client
;
507 client
= data
->client
;
508 regmap
= devm_regmap_init_i2c(client
, &stk3310_regmap_config
);
509 if (IS_ERR(regmap
)) {
510 dev_err(&client
->dev
, "regmap initialization failed.\n");
511 return PTR_ERR(regmap
);
513 data
->regmap
= regmap
;
515 STK3310_REGFIELD(state
);
516 STK3310_REGFIELD(als_gain
);
517 STK3310_REGFIELD(ps_gain
);
518 STK3310_REGFIELD(als_it
);
519 STK3310_REGFIELD(ps_it
);
520 STK3310_REGFIELD(int_ps
);
521 STK3310_REGFIELD(flag_psint
);
522 STK3310_REGFIELD(flag_nf
);
527 static irqreturn_t
stk3310_irq_handler(int irq
, void *private)
529 struct iio_dev
*indio_dev
= private;
530 struct stk3310_data
*data
= iio_priv(indio_dev
);
532 data
->timestamp
= iio_get_time_ns();
534 return IRQ_WAKE_THREAD
;
537 static irqreturn_t
stk3310_irq_event_handler(int irq
, void *private)
543 struct iio_dev
*indio_dev
= private;
544 struct stk3310_data
*data
= iio_priv(indio_dev
);
546 /* Read FLAG_NF to figure out what threshold has been met. */
547 mutex_lock(&data
->lock
);
548 ret
= regmap_field_read(data
->reg_flag_nf
, &dir
);
550 dev_err(&data
->client
->dev
, "register read failed\n");
551 mutex_unlock(&data
->lock
);
554 event
= IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY
, 1,
556 (dir
? IIO_EV_DIR_FALLING
:
558 iio_push_event(indio_dev
, event
, data
->timestamp
);
560 /* Reset the interrupt flag */
561 ret
= regmap_field_write(data
->reg_flag_psint
, 0);
563 dev_err(&data
->client
->dev
, "failed to reset interrupts\n");
564 mutex_unlock(&data
->lock
);
569 static int stk3310_probe(struct i2c_client
*client
,
570 const struct i2c_device_id
*id
)
573 struct iio_dev
*indio_dev
;
574 struct stk3310_data
*data
;
576 indio_dev
= devm_iio_device_alloc(&client
->dev
, sizeof(*data
));
578 dev_err(&client
->dev
, "iio allocation failed!\n");
582 data
= iio_priv(indio_dev
);
583 data
->client
= client
;
584 i2c_set_clientdata(client
, indio_dev
);
585 mutex_init(&data
->lock
);
587 ret
= stk3310_regmap_init(data
);
591 indio_dev
->dev
.parent
= &client
->dev
;
592 indio_dev
->info
= &stk3310_info
;
593 indio_dev
->name
= STK3310_DRIVER_NAME
;
594 indio_dev
->modes
= INDIO_DIRECT_MODE
;
595 indio_dev
->channels
= stk3310_channels
;
596 indio_dev
->num_channels
= ARRAY_SIZE(stk3310_channels
);
598 ret
= stk3310_init(indio_dev
);
602 if (client
->irq
> 0) {
603 ret
= devm_request_threaded_irq(&client
->dev
, client
->irq
,
605 stk3310_irq_event_handler
,
606 IRQF_TRIGGER_FALLING
|
608 STK3310_EVENT
, indio_dev
);
610 dev_err(&client
->dev
, "request irq %d failed\n",
616 ret
= iio_device_register(indio_dev
);
618 dev_err(&client
->dev
, "device_register failed\n");
625 stk3310_set_state(data
, STK3310_STATE_STANDBY
);
629 static int stk3310_remove(struct i2c_client
*client
)
631 struct iio_dev
*indio_dev
= i2c_get_clientdata(client
);
633 iio_device_unregister(indio_dev
);
634 return stk3310_set_state(iio_priv(indio_dev
), STK3310_STATE_STANDBY
);
637 #ifdef CONFIG_PM_SLEEP
638 static int stk3310_suspend(struct device
*dev
)
640 struct stk3310_data
*data
;
642 data
= iio_priv(i2c_get_clientdata(to_i2c_client(dev
)));
644 return stk3310_set_state(data
, STK3310_STATE_STANDBY
);
647 static int stk3310_resume(struct device
*dev
)
650 struct stk3310_data
*data
;
652 data
= iio_priv(i2c_get_clientdata(to_i2c_client(dev
)));
653 if (data
->ps_enabled
)
654 state
|= STK3310_STATE_EN_PS
;
655 if (data
->als_enabled
)
656 state
|= STK3310_STATE_EN_ALS
;
658 return stk3310_set_state(data
, state
);
661 static SIMPLE_DEV_PM_OPS(stk3310_pm_ops
, stk3310_suspend
, stk3310_resume
);
663 #define STK3310_PM_OPS (&stk3310_pm_ops)
665 #define STK3310_PM_OPS NULL
668 static const struct i2c_device_id stk3310_i2c_id
[] = {
673 MODULE_DEVICE_TABLE(i2c
, stk3310_i2c_id
);
675 static const struct acpi_device_id stk3310_acpi_id
[] = {
681 MODULE_DEVICE_TABLE(acpi
, stk3310_acpi_id
);
683 static struct i2c_driver stk3310_driver
= {
686 .pm
= STK3310_PM_OPS
,
687 .acpi_match_table
= ACPI_PTR(stk3310_acpi_id
),
689 .probe
= stk3310_probe
,
690 .remove
= stk3310_remove
,
691 .id_table
= stk3310_i2c_id
,
694 module_i2c_driver(stk3310_driver
);
696 MODULE_AUTHOR("Tiberiu Breana <tiberiu.a.breana@intel.com>");
697 MODULE_DESCRIPTION("STK3310 Ambient Light and Proximity Sensor driver");
698 MODULE_LICENSE("GPL v2");