2 * apds9300.c - IIO driver for Avago APDS9300 ambient light sensor
4 * Copyright 2013 Oleksandr Kravchenko <o.v.kravchenko@globallogic.com>
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.
11 #include <linux/module.h>
12 #include <linux/slab.h>
14 #include <linux/i2c.h>
15 #include <linux/err.h>
16 #include <linux/mutex.h>
17 #include <linux/interrupt.h>
18 #include <linux/iio/iio.h>
19 #include <linux/iio/sysfs.h>
20 #include <linux/iio/events.h>
22 #define APDS9300_DRV_NAME "apds9300"
23 #define APDS9300_IRQ_NAME "apds9300_event"
25 /* Command register bits */
26 #define APDS9300_CMD BIT(7) /* Select command register. Must write as 1 */
27 #define APDS9300_WORD BIT(5) /* I2C write/read: if 1 word, if 0 byte */
28 #define APDS9300_CLEAR BIT(6) /* Interrupt clear. Clears pending interrupt */
31 #define APDS9300_CONTROL 0x00 /* Control of basic functions */
32 #define APDS9300_THRESHLOWLOW 0x02 /* Low byte of low interrupt threshold */
33 #define APDS9300_THRESHHIGHLOW 0x04 /* Low byte of high interrupt threshold */
34 #define APDS9300_INTERRUPT 0x06 /* Interrupt control */
35 #define APDS9300_DATA0LOW 0x0c /* Low byte of ADC channel 0 */
36 #define APDS9300_DATA1LOW 0x0e /* Low byte of ADC channel 1 */
38 /* Power on/off value for APDS9300_CONTROL register */
39 #define APDS9300_POWER_ON 0x03
40 #define APDS9300_POWER_OFF 0x00
43 #define APDS9300_INTR_ENABLE 0x10
44 /* Interrupt Persist Function: Any value outside of threshold range */
45 #define APDS9300_THRESH_INTR 0x01
47 #define APDS9300_THRESH_MAX 0xffff /* Max threshold value */
49 struct apds9300_data
{
50 struct i2c_client
*client
;
60 /* Calculated values 1000 * (CH1/CH0)^1.4 for CH1/CH0 from 0 to 0.52 */
61 static const u16 apds9300_lux_ratio
[] = {
62 0, 2, 4, 7, 11, 15, 19, 24, 29, 34, 40, 45, 51, 57, 64, 70, 77, 84, 91,
63 98, 105, 112, 120, 128, 136, 144, 152, 160, 168, 177, 185, 194, 203,
64 212, 221, 230, 239, 249, 258, 268, 277, 287, 297, 307, 317, 327, 337,
65 347, 358, 368, 379, 390, 400,
68 static unsigned long apds9300_calculate_lux(u16 ch0
, u16 ch1
)
70 unsigned long lux
, tmp
;
72 /* avoid division by zero */
76 tmp
= DIV_ROUND_UP(ch1
* 100, ch0
);
78 lux
= 3150 * ch0
- (unsigned long)DIV_ROUND_UP_ULL(ch0
79 * apds9300_lux_ratio
[tmp
] * 5930ull, 1000);
80 } else if (tmp
<= 65) {
81 lux
= 2290 * ch0
- 2910 * ch1
;
82 } else if (tmp
<= 80) {
83 lux
= 1570 * ch0
- 1800 * ch1
;
84 } else if (tmp
<= 130) {
85 lux
= 338 * ch0
- 260 * ch1
;
93 static int apds9300_get_adc_val(struct apds9300_data
*data
, int adc_number
)
96 u8 flags
= APDS9300_CMD
| APDS9300_WORD
;
98 if (!data
->power_state
)
101 /* Select ADC0 or ADC1 data register */
102 flags
|= adc_number
? APDS9300_DATA1LOW
: APDS9300_DATA0LOW
;
104 ret
= i2c_smbus_read_word_data(data
->client
, flags
);
106 dev_err(&data
->client
->dev
,
107 "failed to read ADC%d value\n", adc_number
);
112 static int apds9300_set_thresh_low(struct apds9300_data
*data
, int value
)
116 if (!data
->power_state
)
119 if (value
> APDS9300_THRESH_MAX
)
122 ret
= i2c_smbus_write_word_data(data
->client
, APDS9300_THRESHLOWLOW
123 | APDS9300_CMD
| APDS9300_WORD
, value
);
125 dev_err(&data
->client
->dev
, "failed to set thresh_low\n");
128 data
->thresh_low
= value
;
133 static int apds9300_set_thresh_hi(struct apds9300_data
*data
, int value
)
137 if (!data
->power_state
)
140 if (value
> APDS9300_THRESH_MAX
)
143 ret
= i2c_smbus_write_word_data(data
->client
, APDS9300_THRESHHIGHLOW
144 | APDS9300_CMD
| APDS9300_WORD
, value
);
146 dev_err(&data
->client
->dev
, "failed to set thresh_hi\n");
149 data
->thresh_hi
= value
;
154 static int apds9300_set_intr_state(struct apds9300_data
*data
, int state
)
159 if (!data
->power_state
)
162 cmd
= state
? APDS9300_INTR_ENABLE
| APDS9300_THRESH_INTR
: 0x00;
163 ret
= i2c_smbus_write_byte_data(data
->client
,
164 APDS9300_INTERRUPT
| APDS9300_CMD
, cmd
);
166 dev_err(&data
->client
->dev
,
167 "failed to set interrupt state %d\n", state
);
170 data
->intr_en
= state
;
175 static int apds9300_set_power_state(struct apds9300_data
*data
, int state
)
180 cmd
= state
? APDS9300_POWER_ON
: APDS9300_POWER_OFF
;
181 ret
= i2c_smbus_write_byte_data(data
->client
,
182 APDS9300_CONTROL
| APDS9300_CMD
, cmd
);
184 dev_err(&data
->client
->dev
,
185 "failed to set power state %d\n", state
);
188 data
->power_state
= state
;
193 static void apds9300_clear_intr(struct apds9300_data
*data
)
197 ret
= i2c_smbus_write_byte(data
->client
, APDS9300_CLEAR
| APDS9300_CMD
);
199 dev_err(&data
->client
->dev
, "failed to clear interrupt\n");
202 static int apds9300_chip_init(struct apds9300_data
*data
)
206 /* Need to set power off to ensure that the chip is off */
207 ret
= apds9300_set_power_state(data
, 0);
211 * Probe the chip. To do so we try to power up the device and then to
212 * read back the 0x03 code
214 ret
= apds9300_set_power_state(data
, 1);
217 ret
= i2c_smbus_read_byte_data(data
->client
,
218 APDS9300_CONTROL
| APDS9300_CMD
);
219 if (ret
!= APDS9300_POWER_ON
) {
224 * Disable interrupt to ensure thai it is doesn't enable
225 * i.e. after device soft reset
227 ret
= apds9300_set_intr_state(data
, 0);
234 dev_err(&data
->client
->dev
, "failed to init the chip\n");
238 static int apds9300_read_raw(struct iio_dev
*indio_dev
,
239 struct iio_chan_spec
const *chan
, int *val
, int *val2
,
242 int ch0
, ch1
, ret
= -EINVAL
;
243 struct apds9300_data
*data
= iio_priv(indio_dev
);
245 mutex_lock(&data
->mutex
);
246 switch (chan
->type
) {
248 ch0
= apds9300_get_adc_val(data
, 0);
253 ch1
= apds9300_get_adc_val(data
, 1);
258 *val
= apds9300_calculate_lux(ch0
, ch1
);
262 ret
= apds9300_get_adc_val(data
, chan
->channel
);
271 mutex_unlock(&data
->mutex
);
276 static int apds9300_read_thresh(struct iio_dev
*indio_dev
, u64 event_code
,
279 struct apds9300_data
*data
= iio_priv(indio_dev
);
281 switch (IIO_EVENT_CODE_EXTRACT_DIR(event_code
)) {
282 case IIO_EV_DIR_RISING
:
283 *val
= data
->thresh_hi
;
285 case IIO_EV_DIR_FALLING
:
286 *val
= data
->thresh_low
;
295 static int apds9300_write_thresh(struct iio_dev
*indio_dev
, u64 event_code
,
298 struct apds9300_data
*data
= iio_priv(indio_dev
);
301 mutex_lock(&data
->mutex
);
302 if (IIO_EVENT_CODE_EXTRACT_DIR(event_code
) == IIO_EV_DIR_RISING
)
303 ret
= apds9300_set_thresh_hi(data
, val
);
305 ret
= apds9300_set_thresh_low(data
, val
);
306 mutex_unlock(&data
->mutex
);
311 static int apds9300_read_interrupt_config(struct iio_dev
*indio_dev
,
314 struct apds9300_data
*data
= iio_priv(indio_dev
);
316 return data
->intr_en
;
319 static int apds9300_write_interrupt_config(struct iio_dev
*indio_dev
,
320 u64 event_code
, int state
)
322 struct apds9300_data
*data
= iio_priv(indio_dev
);
325 mutex_lock(&data
->mutex
);
326 ret
= apds9300_set_intr_state(data
, state
);
327 mutex_unlock(&data
->mutex
);
332 static const struct iio_info apds9300_info_no_irq
= {
333 .driver_module
= THIS_MODULE
,
334 .read_raw
= apds9300_read_raw
,
337 static const struct iio_info apds9300_info
= {
338 .driver_module
= THIS_MODULE
,
339 .read_raw
= apds9300_read_raw
,
340 .read_event_value
= apds9300_read_thresh
,
341 .write_event_value
= apds9300_write_thresh
,
342 .read_event_config
= apds9300_read_interrupt_config
,
343 .write_event_config
= apds9300_write_interrupt_config
,
346 static const struct iio_chan_spec apds9300_channels
[] = {
351 .info_mask_separate
= BIT(IIO_CHAN_INFO_PROCESSED
),
353 .type
= IIO_INTENSITY
,
355 .channel2
= IIO_MOD_LIGHT_BOTH
,
357 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
358 .event_mask
= (IIO_EV_BIT(IIO_EV_TYPE_THRESH
,
360 IIO_EV_BIT(IIO_EV_TYPE_THRESH
,
361 IIO_EV_DIR_FALLING
)),
363 .type
= IIO_INTENSITY
,
365 .channel2
= IIO_MOD_LIGHT_IR
,
367 .info_mask_separate
= BIT(IIO_CHAN_INFO_RAW
),
371 static irqreturn_t
apds9300_interrupt_handler(int irq
, void *private)
373 struct iio_dev
*dev_info
= private;
374 struct apds9300_data
*data
= iio_priv(dev_info
);
376 iio_push_event(dev_info
,
377 IIO_UNMOD_EVENT_CODE(IIO_INTENSITY
, 0,
382 apds9300_clear_intr(data
);
387 static int apds9300_probe(struct i2c_client
*client
,
388 const struct i2c_device_id
*id
)
390 struct apds9300_data
*data
;
391 struct iio_dev
*indio_dev
;
394 indio_dev
= devm_iio_device_alloc(&client
->dev
, sizeof(*data
));
398 data
= iio_priv(indio_dev
);
399 i2c_set_clientdata(client
, indio_dev
);
400 data
->client
= client
;
402 ret
= apds9300_chip_init(data
);
406 mutex_init(&data
->mutex
);
408 indio_dev
->dev
.parent
= &client
->dev
;
409 indio_dev
->channels
= apds9300_channels
;
410 indio_dev
->num_channels
= ARRAY_SIZE(apds9300_channels
);
411 indio_dev
->name
= APDS9300_DRV_NAME
;
412 indio_dev
->modes
= INDIO_DIRECT_MODE
;
415 indio_dev
->info
= &apds9300_info
;
417 indio_dev
->info
= &apds9300_info_no_irq
;
420 ret
= devm_request_threaded_irq(&client
->dev
, client
->irq
,
421 NULL
, apds9300_interrupt_handler
,
422 IRQF_TRIGGER_FALLING
| IRQF_ONESHOT
,
423 APDS9300_IRQ_NAME
, indio_dev
);
425 dev_err(&client
->dev
, "irq request error %d\n", -ret
);
430 ret
= iio_device_register(indio_dev
);
437 /* Ensure that power off in case of error */
438 apds9300_set_power_state(data
, 0);
442 static int apds9300_remove(struct i2c_client
*client
)
444 struct iio_dev
*indio_dev
= i2c_get_clientdata(client
);
445 struct apds9300_data
*data
= iio_priv(indio_dev
);
447 iio_device_unregister(indio_dev
);
449 /* Ensure that power off and interrupts are disabled */
450 apds9300_set_intr_state(data
, 0);
451 apds9300_set_power_state(data
, 0);
456 #ifdef CONFIG_PM_SLEEP
457 static int apds9300_suspend(struct device
*dev
)
459 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
460 struct apds9300_data
*data
= iio_priv(indio_dev
);
463 mutex_lock(&data
->mutex
);
464 ret
= apds9300_set_power_state(data
, 0);
465 mutex_unlock(&data
->mutex
);
470 static int apds9300_resume(struct device
*dev
)
472 struct iio_dev
*indio_dev
= i2c_get_clientdata(to_i2c_client(dev
));
473 struct apds9300_data
*data
= iio_priv(indio_dev
);
476 mutex_lock(&data
->mutex
);
477 ret
= apds9300_set_power_state(data
, 1);
478 mutex_unlock(&data
->mutex
);
483 static SIMPLE_DEV_PM_OPS(apds9300_pm_ops
, apds9300_suspend
, apds9300_resume
);
484 #define APDS9300_PM_OPS (&apds9300_pm_ops)
486 #define APDS9300_PM_OPS NULL
489 static struct i2c_device_id apds9300_id
[] = {
490 { APDS9300_DRV_NAME
, 0 },
494 MODULE_DEVICE_TABLE(i2c
, apds9300_id
);
496 static struct i2c_driver apds9300_driver
= {
498 .name
= APDS9300_DRV_NAME
,
499 .owner
= THIS_MODULE
,
500 .pm
= APDS9300_PM_OPS
,
502 .probe
= apds9300_probe
,
503 .remove
= apds9300_remove
,
504 .id_table
= apds9300_id
,
507 module_i2c_driver(apds9300_driver
);
509 MODULE_AUTHOR("Kravchenko Oleksandr <o.v.kravchenko@globallogic.com>");
510 MODULE_AUTHOR("GlobalLogic inc.");
511 MODULE_DESCRIPTION("APDS9300 ambient light photo sensor driver");
512 MODULE_LICENSE("GPL");