2 * This file is part of the APDS990x sensor driver.
3 * Chip is combined proximity and ambient light sensor.
5 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
7 * Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * version 2 as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/i2c.h>
28 #include <linux/interrupt.h>
29 #include <linux/mutex.h>
30 #include <linux/regulator/consumer.h>
31 #include <linux/pm_runtime.h>
32 #include <linux/delay.h>
33 #include <linux/wait.h>
34 #include <linux/slab.h>
35 #include <linux/i2c/apds990x.h>
38 #define APDS990X_ENABLE 0x00 /* Enable of states and interrupts */
39 #define APDS990X_ATIME 0x01 /* ALS ADC time */
40 #define APDS990X_PTIME 0x02 /* Proximity ADC time */
41 #define APDS990X_WTIME 0x03 /* Wait time */
42 #define APDS990X_AILTL 0x04 /* ALS interrupt low threshold low byte */
43 #define APDS990X_AILTH 0x05 /* ALS interrupt low threshold hi byte */
44 #define APDS990X_AIHTL 0x06 /* ALS interrupt hi threshold low byte */
45 #define APDS990X_AIHTH 0x07 /* ALS interrupt hi threshold hi byte */
46 #define APDS990X_PILTL 0x08 /* Proximity interrupt low threshold low byte */
47 #define APDS990X_PILTH 0x09 /* Proximity interrupt low threshold hi byte */
48 #define APDS990X_PIHTL 0x0a /* Proximity interrupt hi threshold low byte */
49 #define APDS990X_PIHTH 0x0b /* Proximity interrupt hi threshold hi byte */
50 #define APDS990X_PERS 0x0c /* Interrupt persistence filters */
51 #define APDS990X_CONFIG 0x0d /* Configuration */
52 #define APDS990X_PPCOUNT 0x0e /* Proximity pulse count */
53 #define APDS990X_CONTROL 0x0f /* Gain control register */
54 #define APDS990X_REV 0x11 /* Revision Number */
55 #define APDS990X_ID 0x12 /* Device ID */
56 #define APDS990X_STATUS 0x13 /* Device status */
57 #define APDS990X_CDATAL 0x14 /* Clear ADC low data register */
58 #define APDS990X_CDATAH 0x15 /* Clear ADC high data register */
59 #define APDS990X_IRDATAL 0x16 /* IR ADC low data register */
60 #define APDS990X_IRDATAH 0x17 /* IR ADC high data register */
61 #define APDS990X_PDATAL 0x18 /* Proximity ADC low data register */
62 #define APDS990X_PDATAH 0x19 /* Proximity ADC high data register */
65 #define APDS990X_MAX_AGAIN 3
68 #define APDS990X_EN_PIEN (0x1 << 5)
69 #define APDS990X_EN_AIEN (0x1 << 4)
70 #define APDS990X_EN_WEN (0x1 << 3)
71 #define APDS990X_EN_PEN (0x1 << 2)
72 #define APDS990X_EN_AEN (0x1 << 1)
73 #define APDS990X_EN_PON (0x1 << 0)
74 #define APDS990X_EN_DISABLE_ALL 0
77 #define APDS990X_ST_PINT (0x1 << 5)
78 #define APDS990X_ST_AINT (0x1 << 4)
80 /* I2C access types */
81 #define APDS990x_CMD_TYPE_MASK (0x03 << 5)
82 #define APDS990x_CMD_TYPE_RB (0x00 << 5) /* Repeated byte */
83 #define APDS990x_CMD_TYPE_INC (0x01 << 5) /* Auto increment */
84 #define APDS990x_CMD_TYPE_SPE (0x03 << 5) /* Special function */
86 #define APDS990x_ADDR_SHIFT 0
87 #define APDS990x_CMD 0x80
89 /* Interrupt ack commands */
90 #define APDS990X_INT_ACK_ALS 0x6
91 #define APDS990X_INT_ACK_PS 0x5
92 #define APDS990X_INT_ACK_BOTH 0x7
95 #define APDS990X_PTIME_DEFAULT 0xff /* Recommended conversion time 2.7ms*/
98 #define APDS990X_WTIME_DEFAULT 0xee /* ~50ms wait time */
100 #define APDS990X_TIME_TO_ADC 1024 /* One timetick as ADC count value */
103 #define APDS990X_APERS_SHIFT 0
104 #define APDS990X_PPERS_SHIFT 4
107 #define APDS990X_ID_0 0x0
108 #define APDS990X_ID_4 0x4
109 #define APDS990X_ID_29 0x29
111 /* pgain and pdiode settings */
112 #define APDS_PGAIN_1X 0x0
113 #define APDS_PDIODE_IR 0x2
115 #define APDS990X_LUX_OUTPUT_SCALE 10
117 /* Reverse chip factors for threshold calculation */
118 struct reverse_factors {
126 struct apds990x_chip {
127 struct apds990x_platform_data *pdata;
128 struct i2c_client *client;
129 struct mutex mutex; /* avoid parallel access */
130 struct regulator_bulk_data regs[2];
131 wait_queue_head_t wait;
134 bool prox_continuous_mode;
135 bool lux_wait_fresh_res;
137 /* Chip parameters */
138 struct apds990x_chip_factors cf;
139 struct reverse_factors rcf;
140 u16 atime; /* als integration time */
141 u16 arate; /* als reporting rate */
142 u16 a_max_result; /* Max possible ADC value with current atime */
143 u8 again_meas; /* Gain used in last measurement */
144 u8 again_next; /* Next calculated gain */
167 #define APDS_CALIB_SCALER 8192
168 #define APDS_LUX_NEUTRAL_CALIB_VALUE (1 * APDS_CALIB_SCALER)
169 #define APDS_PROX_NEUTRAL_CALIB_VALUE (1 * APDS_CALIB_SCALER)
171 #define APDS_PROX_DEF_THRES 600
172 #define APDS_PROX_HYSTERESIS 50
173 #define APDS_LUX_DEF_THRES_HI 101
174 #define APDS_LUX_DEF_THRES_LO 100
175 #define APDS_DEFAULT_PROX_PERS 1
177 #define APDS_TIMEOUT 2000
178 #define APDS_STARTUP_DELAY 25000 /* us */
179 #define APDS_RANGE 65535
180 #define APDS_PROX_RANGE 1023
181 #define APDS_LUX_GAIN_LO_LIMIT 100
182 #define APDS_LUX_GAIN_LO_LIMIT_STRICT 25
184 #define TIMESTEP 87 /* 2.7ms is about 87 / 32 */
185 #define TIME_STEP_SCALER 32
187 #define APDS_LUX_AVERAGING_TIME 50 /* tolerates 50/60Hz ripple */
188 #define APDS_LUX_DEFAULT_RATE 200
190 static const u8 again[] = {1, 8, 16, 120}; /* ALS gain steps */
191 static const u8 ir_currents[] = {100, 50, 25, 12}; /* IRled currents in mA */
193 /* Following two tables must match i.e 10Hz rate means 1 as persistence value */
194 static const u16 arates_hz[] = {10, 5, 2, 1};
195 static const u8 apersis[] = {1, 2, 4, 5};
198 static const char reg_vcc[] = "Vdd";
199 static const char reg_vled[] = "Vled";
201 static int apds990x_read_byte(struct apds990x_chip *chip, u8 reg, u8 *data)
203 struct i2c_client *client = chip->client;
206 reg &= ~APDS990x_CMD_TYPE_MASK;
207 reg |= APDS990x_CMD | APDS990x_CMD_TYPE_RB;
209 ret = i2c_smbus_read_byte_data(client, reg);
214 static int apds990x_read_word(struct apds990x_chip *chip, u8 reg, u16 *data)
216 struct i2c_client *client = chip->client;
219 reg &= ~APDS990x_CMD_TYPE_MASK;
220 reg |= APDS990x_CMD | APDS990x_CMD_TYPE_INC;
222 ret = i2c_smbus_read_word_data(client, reg);
227 static int apds990x_write_byte(struct apds990x_chip *chip, u8 reg, u8 data)
229 struct i2c_client *client = chip->client;
232 reg &= ~APDS990x_CMD_TYPE_MASK;
233 reg |= APDS990x_CMD | APDS990x_CMD_TYPE_RB;
235 ret = i2c_smbus_write_byte_data(client, reg, data);
239 static int apds990x_write_word(struct apds990x_chip *chip, u8 reg, u16 data)
241 struct i2c_client *client = chip->client;
244 reg &= ~APDS990x_CMD_TYPE_MASK;
245 reg |= APDS990x_CMD | APDS990x_CMD_TYPE_INC;
247 ret = i2c_smbus_write_word_data(client, reg, data);
251 static int apds990x_mode_on(struct apds990x_chip *chip)
253 /* ALS is mandatory, proximity optional */
254 u8 reg = APDS990X_EN_AIEN | APDS990X_EN_PON | APDS990X_EN_AEN |
258 reg |= APDS990X_EN_PIEN | APDS990X_EN_PEN;
260 return apds990x_write_byte(chip, APDS990X_ENABLE, reg);
263 static u16 apds990x_lux_to_threshold(struct apds990x_chip *chip, u32 lux)
271 else if (lux == APDS_RANGE)
275 * Reported LUX value is a combination of the IR and CLEAR channel
276 * values. However, interrupt threshold is only for clear channel.
277 * This function approximates needed HW threshold value for a given
278 * LUX value in the current lightning type.
279 * IR level compared to visible light varies heavily depending on the
280 * source of the light
282 * Calculate threshold value for the next measurement period.
283 * Math: threshold = lux * cpl where
284 * cpl = atime * again / (glass_attenuation * device_factor)
287 * First remove calibration. Division by four is to avoid overflow
289 lux = lux * (APDS_CALIB_SCALER / 4) / (chip->lux_calib / 4);
291 /* Multiplication by 64 is to increase accuracy */
292 cpl = ((u32)chip->atime * (u32)again[chip->again_next] *
293 APDS_PARAM_SCALE * 64) / (chip->cf.ga * chip->cf.df);
295 thres = lux * cpl / 64;
297 * Convert IR light from the latest result to match with
298 * new gain step. This helps to adapt with the current
301 ir = (u32)chip->lux_ir * (u32)again[chip->again_next] /
302 (u32)again[chip->again_meas];
305 * Compensate count with IR light impact
306 * IAC1 > IAC2 (see apds990x_get_lux for formulas)
308 if (chip->lux_clear * APDS_PARAM_SCALE >=
309 chip->rcf.afactor * chip->lux_ir)
310 thres = (chip->rcf.cf1 * thres + chip->rcf.irf1 * ir) /
313 thres = (chip->rcf.cf2 * thres + chip->rcf.irf2 * ir) /
316 if (thres >= chip->a_max_result)
317 thres = chip->a_max_result - 1;
321 static inline int apds990x_set_atime(struct apds990x_chip *chip, u32 time_ms)
325 chip->atime = time_ms;
326 /* Formula is specified in the data sheet */
327 reg_value = 256 - ((time_ms * TIME_STEP_SCALER) / TIMESTEP);
328 /* Calculate max ADC value for given integration time */
329 chip->a_max_result = (u16)(256 - reg_value) * APDS990X_TIME_TO_ADC;
330 return apds990x_write_byte(chip, APDS990X_ATIME, reg_value);
333 /* Called always with mutex locked */
334 static int apds990x_refresh_pthres(struct apds990x_chip *chip, int data)
338 /* If the chip is not in use, don't try to access it */
339 if (pm_runtime_suspended(&chip->client->dev))
342 if (data < chip->prox_thres) {
344 hi = chip->prox_thres;
346 lo = chip->prox_thres - APDS_PROX_HYSTERESIS;
347 if (chip->prox_continuous_mode)
348 hi = chip->prox_thres;
353 ret = apds990x_write_word(chip, APDS990X_PILTL, lo);
354 ret |= apds990x_write_word(chip, APDS990X_PIHTL, hi);
358 /* Called always with mutex locked */
359 static int apds990x_refresh_athres(struct apds990x_chip *chip)
362 /* If the chip is not in use, don't try to access it */
363 if (pm_runtime_suspended(&chip->client->dev))
366 ret = apds990x_write_word(chip, APDS990X_AILTL,
367 apds990x_lux_to_threshold(chip, chip->lux_thres_lo));
368 ret |= apds990x_write_word(chip, APDS990X_AIHTL,
369 apds990x_lux_to_threshold(chip, chip->lux_thres_hi));
374 /* Called always with mutex locked */
375 static void apds990x_force_a_refresh(struct apds990x_chip *chip)
377 /* This will force ALS interrupt after the next measurement. */
378 apds990x_write_word(chip, APDS990X_AILTL, APDS_LUX_DEF_THRES_LO);
379 apds990x_write_word(chip, APDS990X_AIHTL, APDS_LUX_DEF_THRES_HI);
382 /* Called always with mutex locked */
383 static void apds990x_force_p_refresh(struct apds990x_chip *chip)
385 /* This will force proximity interrupt after the next measurement. */
386 apds990x_write_word(chip, APDS990X_PILTL, APDS_PROX_DEF_THRES - 1);
387 apds990x_write_word(chip, APDS990X_PIHTL, APDS_PROX_DEF_THRES);
390 /* Called always with mutex locked */
391 static int apds990x_calc_again(struct apds990x_chip *chip)
393 int curr_again = chip->again_meas;
394 int next_again = chip->again_meas;
397 /* Calculate suitable als gain */
398 if (chip->lux_clear == chip->a_max_result)
399 next_again -= 2; /* ALS saturated. Decrease gain by 2 steps */
400 else if (chip->lux_clear > chip->a_max_result / 2)
402 else if (chip->lux_clear < APDS_LUX_GAIN_LO_LIMIT_STRICT)
403 next_again += 2; /* Too dark. Increase gain by 2 steps */
404 else if (chip->lux_clear < APDS_LUX_GAIN_LO_LIMIT)
407 /* Limit gain to available range */
410 else if (next_again > APDS990X_MAX_AGAIN)
411 next_again = APDS990X_MAX_AGAIN;
413 /* Let's check can we trust the measured result */
414 if (chip->lux_clear == chip->a_max_result)
415 /* Result can be totally garbage due to saturation */
417 else if (next_again != curr_again &&
418 chip->lux_clear < APDS_LUX_GAIN_LO_LIMIT_STRICT)
420 * Gain is changed and measurement result is very small.
421 * Result can be totally garbage due to underflow
425 chip->again_next = next_again;
426 apds990x_write_byte(chip, APDS990X_CONTROL,
427 (chip->pdrive << 6) |
428 (chip->pdiode << 4) |
430 (chip->again_next << 0));
433 * Error means bad result -> re-measurement is needed. The forced
434 * refresh uses fastest possible persistence setting to get result
435 * as soon as possible.
438 apds990x_force_a_refresh(chip);
440 apds990x_refresh_athres(chip);
445 /* Called always with mutex locked */
446 static int apds990x_get_lux(struct apds990x_chip *chip, int clear, int ir)
448 int iac, iac1, iac2; /* IR adjusted counts */
449 u32 lpc; /* Lux per count */
452 * iac1 = CF1 * CLEAR_CH - IRF1 * IR_CH
453 * iac2 = CF2 * CLEAR_CH - IRF2 * IR_CH
455 iac1 = (chip->cf.cf1 * clear - chip->cf.irf1 * ir) / APDS_PARAM_SCALE;
456 iac2 = (chip->cf.cf2 * clear - chip->cf.irf2 * ir) / APDS_PARAM_SCALE;
458 iac = max(iac1, iac2);
461 lpc = APDS990X_LUX_OUTPUT_SCALE * (chip->cf.df * chip->cf.ga) /
462 (u32)(again[chip->again_meas] * (u32)chip->atime);
464 return (iac * lpc) / APDS_PARAM_SCALE;
467 static int apds990x_ack_int(struct apds990x_chip *chip, u8 mode)
469 struct i2c_client *client = chip->client;
471 u8 reg = APDS990x_CMD | APDS990x_CMD_TYPE_SPE;
473 switch (mode & (APDS990X_ST_AINT | APDS990X_ST_PINT)) {
474 case APDS990X_ST_AINT:
475 reg |= APDS990X_INT_ACK_ALS;
477 case APDS990X_ST_PINT:
478 reg |= APDS990X_INT_ACK_PS;
481 reg |= APDS990X_INT_ACK_BOTH;
485 ret = i2c_smbus_read_byte_data(client, reg);
489 static irqreturn_t apds990x_irq(int irq, void *data)
491 struct apds990x_chip *chip = data;
494 apds990x_read_byte(chip, APDS990X_STATUS, &status);
495 apds990x_ack_int(chip, status);
497 mutex_lock(&chip->mutex);
498 if (!pm_runtime_suspended(&chip->client->dev)) {
499 if (status & APDS990X_ST_AINT) {
500 apds990x_read_word(chip, APDS990X_CDATAL,
502 apds990x_read_word(chip, APDS990X_IRDATAL,
504 /* Store used gain for calculations */
505 chip->again_meas = chip->again_next;
507 chip->lux_raw = apds990x_get_lux(chip,
511 if (apds990x_calc_again(chip) == 0) {
512 /* Result is valid */
513 chip->lux = chip->lux_raw;
514 chip->lux_wait_fresh_res = false;
515 wake_up(&chip->wait);
516 sysfs_notify(&chip->client->dev.kobj,
521 if ((status & APDS990X_ST_PINT) && chip->prox_en) {
524 apds990x_read_word(chip, APDS990X_CDATAL, &clr_ch);
526 * If ALS channel is saturated at min gain,
527 * proximity gives false posivite values.
530 if (chip->again_meas == 0 &&
531 clr_ch == chip->a_max_result)
534 apds990x_read_word(chip,
538 apds990x_refresh_pthres(chip, chip->prox_data);
539 if (chip->prox_data < chip->prox_thres)
541 else if (!chip->prox_continuous_mode)
542 chip->prox_data = APDS_PROX_RANGE;
543 sysfs_notify(&chip->client->dev.kobj,
547 mutex_unlock(&chip->mutex);
551 static int apds990x_configure(struct apds990x_chip *chip)
553 /* It is recommended to use disabled mode during these operations */
554 apds990x_write_byte(chip, APDS990X_ENABLE, APDS990X_EN_DISABLE_ALL);
556 /* conversion and wait times for different state machince states */
557 apds990x_write_byte(chip, APDS990X_PTIME, APDS990X_PTIME_DEFAULT);
558 apds990x_write_byte(chip, APDS990X_WTIME, APDS990X_WTIME_DEFAULT);
559 apds990x_set_atime(chip, APDS_LUX_AVERAGING_TIME);
561 apds990x_write_byte(chip, APDS990X_CONFIG, 0);
563 /* Persistence levels */
564 apds990x_write_byte(chip, APDS990X_PERS,
565 (chip->lux_persistence << APDS990X_APERS_SHIFT) |
566 (chip->prox_persistence << APDS990X_PPERS_SHIFT));
568 apds990x_write_byte(chip, APDS990X_PPCOUNT, chip->pdata->ppcount);
570 /* Start with relatively small gain */
571 chip->again_meas = 1;
572 chip->again_next = 1;
573 apds990x_write_byte(chip, APDS990X_CONTROL,
574 (chip->pdrive << 6) |
575 (chip->pdiode << 4) |
577 (chip->again_next << 0));
581 static int apds990x_detect(struct apds990x_chip *chip)
583 struct i2c_client *client = chip->client;
587 ret = apds990x_read_byte(chip, APDS990X_ID, &id);
589 dev_err(&client->dev, "ID read failed\n");
593 ret = apds990x_read_byte(chip, APDS990X_REV, &chip->revision);
595 dev_err(&client->dev, "REV read failed\n");
603 snprintf(chip->chipname, sizeof(chip->chipname), "APDS-990x");
612 #if defined(CONFIG_PM) || defined(CONFIG_PM_RUNTIME)
613 static int apds990x_chip_on(struct apds990x_chip *chip)
615 int err = regulator_bulk_enable(ARRAY_SIZE(chip->regs),
620 usleep_range(APDS_STARTUP_DELAY, 2 * APDS_STARTUP_DELAY);
622 /* Refresh all configs in case of regulators were off */
624 apds990x_configure(chip);
625 apds990x_mode_on(chip);
630 static int apds990x_chip_off(struct apds990x_chip *chip)
632 apds990x_write_byte(chip, APDS990X_ENABLE, APDS990X_EN_DISABLE_ALL);
633 regulator_bulk_disable(ARRAY_SIZE(chip->regs), chip->regs);
637 static ssize_t apds990x_lux_show(struct device *dev,
638 struct device_attribute *attr, char *buf)
640 struct apds990x_chip *chip = dev_get_drvdata(dev);
645 if (pm_runtime_suspended(dev))
648 timeout = wait_event_interruptible_timeout(chip->wait,
649 !chip->lux_wait_fresh_res,
650 msecs_to_jiffies(APDS_TIMEOUT));
654 mutex_lock(&chip->mutex);
655 result = (chip->lux * chip->lux_calib) / APDS_CALIB_SCALER;
656 if (result > (APDS_RANGE * APDS990X_LUX_OUTPUT_SCALE))
657 result = APDS_RANGE * APDS990X_LUX_OUTPUT_SCALE;
659 ret = sprintf(buf, "%d.%d\n",
660 result / APDS990X_LUX_OUTPUT_SCALE,
661 result % APDS990X_LUX_OUTPUT_SCALE);
662 mutex_unlock(&chip->mutex);
666 static DEVICE_ATTR(lux0_input, S_IRUGO, apds990x_lux_show, NULL);
668 static ssize_t apds990x_lux_range_show(struct device *dev,
669 struct device_attribute *attr, char *buf)
671 return sprintf(buf, "%u\n", APDS_RANGE);
674 static DEVICE_ATTR(lux0_sensor_range, S_IRUGO, apds990x_lux_range_show, NULL);
676 static ssize_t apds990x_lux_calib_format_show(struct device *dev,
677 struct device_attribute *attr, char *buf)
679 return sprintf(buf, "%u\n", APDS_CALIB_SCALER);
682 static DEVICE_ATTR(lux0_calibscale_default, S_IRUGO,
683 apds990x_lux_calib_format_show, NULL);
685 static ssize_t apds990x_lux_calib_show(struct device *dev,
686 struct device_attribute *attr, char *buf)
688 struct apds990x_chip *chip = dev_get_drvdata(dev);
690 return sprintf(buf, "%u\n", chip->lux_calib);
693 static ssize_t apds990x_lux_calib_store(struct device *dev,
694 struct device_attribute *attr,
695 const char *buf, size_t len)
697 struct apds990x_chip *chip = dev_get_drvdata(dev);
700 if (strict_strtoul(buf, 0, &value))
703 chip->lux_calib = value;
708 static DEVICE_ATTR(lux0_calibscale, S_IRUGO | S_IWUSR, apds990x_lux_calib_show,
709 apds990x_lux_calib_store);
711 static ssize_t apds990x_rate_avail(struct device *dev,
712 struct device_attribute *attr, char *buf)
716 for (i = 0; i < ARRAY_SIZE(arates_hz); i++)
717 pos += sprintf(buf + pos, "%d ", arates_hz[i]);
718 sprintf(buf + pos - 1, "\n");
722 static ssize_t apds990x_rate_show(struct device *dev,
723 struct device_attribute *attr, char *buf)
725 struct apds990x_chip *chip = dev_get_drvdata(dev);
726 return sprintf(buf, "%d\n", chip->arate);
729 static int apds990x_set_arate(struct apds990x_chip *chip, int rate)
733 for (i = 0; i < ARRAY_SIZE(arates_hz); i++)
734 if (rate >= arates_hz[i])
737 if (i == ARRAY_SIZE(arates_hz))
740 /* Pick up corresponding persistence value */
741 chip->lux_persistence = apersis[i];
742 chip->arate = arates_hz[i];
744 /* If the chip is not in use, don't try to access it */
745 if (pm_runtime_suspended(&chip->client->dev))
748 /* Persistence levels */
749 return apds990x_write_byte(chip, APDS990X_PERS,
750 (chip->lux_persistence << APDS990X_APERS_SHIFT) |
751 (chip->prox_persistence << APDS990X_PPERS_SHIFT));
754 static ssize_t apds990x_rate_store(struct device *dev,
755 struct device_attribute *attr,
756 const char *buf, size_t len)
758 struct apds990x_chip *chip = dev_get_drvdata(dev);
762 if (strict_strtoul(buf, 0, &value))
765 mutex_lock(&chip->mutex);
766 ret = apds990x_set_arate(chip, value);
767 mutex_unlock(&chip->mutex);
774 static DEVICE_ATTR(lux0_rate_avail, S_IRUGO, apds990x_rate_avail, NULL);
776 static DEVICE_ATTR(lux0_rate, S_IRUGO | S_IWUSR, apds990x_rate_show,
777 apds990x_rate_store);
779 static ssize_t apds990x_prox_show(struct device *dev,
780 struct device_attribute *attr, char *buf)
783 struct apds990x_chip *chip = dev_get_drvdata(dev);
784 if (pm_runtime_suspended(dev) || !chip->prox_en)
787 mutex_lock(&chip->mutex);
788 ret = sprintf(buf, "%d\n", chip->prox_data);
789 mutex_unlock(&chip->mutex);
793 static DEVICE_ATTR(prox0_raw, S_IRUGO, apds990x_prox_show, NULL);
795 static ssize_t apds990x_prox_range_show(struct device *dev,
796 struct device_attribute *attr, char *buf)
798 return sprintf(buf, "%u\n", APDS_PROX_RANGE);
801 static DEVICE_ATTR(prox0_sensor_range, S_IRUGO, apds990x_prox_range_show, NULL);
803 static ssize_t apds990x_prox_enable_show(struct device *dev,
804 struct device_attribute *attr, char *buf)
806 struct apds990x_chip *chip = dev_get_drvdata(dev);
807 return sprintf(buf, "%d\n", chip->prox_en);
810 static ssize_t apds990x_prox_enable_store(struct device *dev,
811 struct device_attribute *attr,
812 const char *buf, size_t len)
814 struct apds990x_chip *chip = dev_get_drvdata(dev);
817 if (strict_strtoul(buf, 0, &value))
820 mutex_lock(&chip->mutex);
827 else if (chip->prox_en > 0)
830 if (!pm_runtime_suspended(dev))
831 apds990x_mode_on(chip);
832 mutex_unlock(&chip->mutex);
836 static DEVICE_ATTR(prox0_raw_en, S_IRUGO | S_IWUSR, apds990x_prox_enable_show,
837 apds990x_prox_enable_store);
839 static const char reporting_modes[][9] = {"trigger", "periodic"};
841 static ssize_t apds990x_prox_reporting_mode_show(struct device *dev,
842 struct device_attribute *attr, char *buf)
844 struct apds990x_chip *chip = dev_get_drvdata(dev);
845 return sprintf(buf, "%s\n",
846 reporting_modes[!!chip->prox_continuous_mode]);
849 static ssize_t apds990x_prox_reporting_mode_store(struct device *dev,
850 struct device_attribute *attr,
851 const char *buf, size_t len)
853 struct apds990x_chip *chip = dev_get_drvdata(dev);
855 if (sysfs_streq(buf, reporting_modes[0]))
856 chip->prox_continuous_mode = 0;
857 else if (sysfs_streq(buf, reporting_modes[1]))
858 chip->prox_continuous_mode = 1;
864 static DEVICE_ATTR(prox0_reporting_mode, S_IRUGO | S_IWUSR,
865 apds990x_prox_reporting_mode_show,
866 apds990x_prox_reporting_mode_store);
868 static ssize_t apds990x_prox_reporting_avail_show(struct device *dev,
869 struct device_attribute *attr, char *buf)
871 return sprintf(buf, "%s %s\n", reporting_modes[0], reporting_modes[1]);
874 static DEVICE_ATTR(prox0_reporting_mode_avail, S_IRUGO | S_IWUSR,
875 apds990x_prox_reporting_avail_show, NULL);
878 static ssize_t apds990x_lux_thresh_above_show(struct device *dev,
879 struct device_attribute *attr, char *buf)
881 struct apds990x_chip *chip = dev_get_drvdata(dev);
882 return sprintf(buf, "%d\n", chip->lux_thres_hi);
885 static ssize_t apds990x_lux_thresh_below_show(struct device *dev,
886 struct device_attribute *attr, char *buf)
888 struct apds990x_chip *chip = dev_get_drvdata(dev);
889 return sprintf(buf, "%d\n", chip->lux_thres_lo);
892 static ssize_t apds990x_set_lux_thresh(struct apds990x_chip *chip, u32 *target,
896 unsigned long thresh;
898 if (strict_strtoul(buf, 0, &thresh))
901 if (thresh > APDS_RANGE)
904 mutex_lock(&chip->mutex);
907 * Don't update values in HW if we are still waiting for
908 * first interrupt to come after device handle open call.
910 if (!chip->lux_wait_fresh_res)
911 apds990x_refresh_athres(chip);
912 mutex_unlock(&chip->mutex);
917 static ssize_t apds990x_lux_thresh_above_store(struct device *dev,
918 struct device_attribute *attr,
919 const char *buf, size_t len)
921 struct apds990x_chip *chip = dev_get_drvdata(dev);
922 int ret = apds990x_set_lux_thresh(chip, &chip->lux_thres_hi, buf);
928 static ssize_t apds990x_lux_thresh_below_store(struct device *dev,
929 struct device_attribute *attr,
930 const char *buf, size_t len)
932 struct apds990x_chip *chip = dev_get_drvdata(dev);
933 int ret = apds990x_set_lux_thresh(chip, &chip->lux_thres_lo, buf);
939 static DEVICE_ATTR(lux0_thresh_above_value, S_IRUGO | S_IWUSR,
940 apds990x_lux_thresh_above_show,
941 apds990x_lux_thresh_above_store);
943 static DEVICE_ATTR(lux0_thresh_below_value, S_IRUGO | S_IWUSR,
944 apds990x_lux_thresh_below_show,
945 apds990x_lux_thresh_below_store);
947 static ssize_t apds990x_prox_threshold_show(struct device *dev,
948 struct device_attribute *attr, char *buf)
950 struct apds990x_chip *chip = dev_get_drvdata(dev);
951 return sprintf(buf, "%d\n", chip->prox_thres);
954 static ssize_t apds990x_prox_threshold_store(struct device *dev,
955 struct device_attribute *attr,
956 const char *buf, size_t len)
958 struct apds990x_chip *chip = dev_get_drvdata(dev);
961 if (strict_strtoul(buf, 0, &value))
964 if ((value > APDS_RANGE) || (value == 0) ||
965 (value < APDS_PROX_HYSTERESIS))
968 mutex_lock(&chip->mutex);
969 chip->prox_thres = value;
971 apds990x_force_p_refresh(chip);
972 mutex_unlock(&chip->mutex);
976 static DEVICE_ATTR(prox0_thresh_above_value, S_IRUGO | S_IWUSR,
977 apds990x_prox_threshold_show,
978 apds990x_prox_threshold_store);
980 static ssize_t apds990x_power_state_show(struct device *dev,
981 struct device_attribute *attr, char *buf)
983 return sprintf(buf, "%d\n", !pm_runtime_suspended(dev));
987 static ssize_t apds990x_power_state_store(struct device *dev,
988 struct device_attribute *attr,
989 const char *buf, size_t len)
991 struct apds990x_chip *chip = dev_get_drvdata(dev);
994 if (strict_strtoul(buf, 0, &value))
997 pm_runtime_get_sync(dev);
998 mutex_lock(&chip->mutex);
999 chip->lux_wait_fresh_res = true;
1000 apds990x_force_a_refresh(chip);
1001 apds990x_force_p_refresh(chip);
1002 mutex_unlock(&chip->mutex);
1004 if (!pm_runtime_suspended(dev))
1005 pm_runtime_put(dev);
1010 static DEVICE_ATTR(power_state, S_IRUGO | S_IWUSR,
1011 apds990x_power_state_show,
1012 apds990x_power_state_store);
1014 static ssize_t apds990x_chip_id_show(struct device *dev,
1015 struct device_attribute *attr, char *buf)
1017 struct apds990x_chip *chip = dev_get_drvdata(dev);
1018 return sprintf(buf, "%s %d\n", chip->chipname, chip->revision);
1021 static DEVICE_ATTR(chip_id, S_IRUGO, apds990x_chip_id_show, NULL);
1023 static struct attribute *sysfs_attrs_ctrl[] = {
1024 &dev_attr_lux0_calibscale.attr,
1025 &dev_attr_lux0_calibscale_default.attr,
1026 &dev_attr_lux0_input.attr,
1027 &dev_attr_lux0_sensor_range.attr,
1028 &dev_attr_lux0_rate.attr,
1029 &dev_attr_lux0_rate_avail.attr,
1030 &dev_attr_lux0_thresh_above_value.attr,
1031 &dev_attr_lux0_thresh_below_value.attr,
1032 &dev_attr_prox0_raw_en.attr,
1033 &dev_attr_prox0_raw.attr,
1034 &dev_attr_prox0_sensor_range.attr,
1035 &dev_attr_prox0_thresh_above_value.attr,
1036 &dev_attr_prox0_reporting_mode.attr,
1037 &dev_attr_prox0_reporting_mode_avail.attr,
1038 &dev_attr_chip_id.attr,
1039 &dev_attr_power_state.attr,
1043 static struct attribute_group apds990x_attribute_group[] = {
1044 {.attrs = sysfs_attrs_ctrl },
1047 static int apds990x_probe(struct i2c_client *client,
1048 const struct i2c_device_id *id)
1050 struct apds990x_chip *chip;
1053 chip = kzalloc(sizeof *chip, GFP_KERNEL);
1057 i2c_set_clientdata(client, chip);
1058 chip->client = client;
1060 init_waitqueue_head(&chip->wait);
1061 mutex_init(&chip->mutex);
1062 chip->pdata = client->dev.platform_data;
1064 if (chip->pdata == NULL) {
1065 dev_err(&client->dev, "platform data is mandatory\n");
1070 if (chip->pdata->cf.ga == 0) {
1071 /* set uncovered sensor default parameters */
1072 chip->cf.ga = 1966; /* 0.48 * APDS_PARAM_SCALE */
1073 chip->cf.cf1 = 4096; /* 1.00 * APDS_PARAM_SCALE */
1074 chip->cf.irf1 = 9134; /* 2.23 * APDS_PARAM_SCALE */
1075 chip->cf.cf2 = 2867; /* 0.70 * APDS_PARAM_SCALE */
1076 chip->cf.irf2 = 5816; /* 1.42 * APDS_PARAM_SCALE */
1079 chip->cf = chip->pdata->cf;
1082 /* precalculate inverse chip factors for threshold control */
1084 (chip->cf.irf1 - chip->cf.irf2) * APDS_PARAM_SCALE /
1085 (chip->cf.cf1 - chip->cf.cf2);
1086 chip->rcf.cf1 = APDS_PARAM_SCALE * APDS_PARAM_SCALE /
1088 chip->rcf.irf1 = chip->cf.irf1 * APDS_PARAM_SCALE /
1090 chip->rcf.cf2 = APDS_PARAM_SCALE * APDS_PARAM_SCALE /
1092 chip->rcf.irf2 = chip->cf.irf2 * APDS_PARAM_SCALE /
1095 /* Set something to start with */
1096 chip->lux_thres_hi = APDS_LUX_DEF_THRES_HI;
1097 chip->lux_thres_lo = APDS_LUX_DEF_THRES_LO;
1098 chip->lux_calib = APDS_LUX_NEUTRAL_CALIB_VALUE;
1100 chip->prox_thres = APDS_PROX_DEF_THRES;
1101 chip->pdrive = chip->pdata->pdrive;
1102 chip->pdiode = APDS_PDIODE_IR;
1103 chip->pgain = APDS_PGAIN_1X;
1104 chip->prox_calib = APDS_PROX_NEUTRAL_CALIB_VALUE;
1105 chip->prox_persistence = APDS_DEFAULT_PROX_PERS;
1106 chip->prox_continuous_mode = false;
1108 chip->regs[0].supply = reg_vcc;
1109 chip->regs[1].supply = reg_vled;
1111 err = regulator_bulk_get(&client->dev,
1112 ARRAY_SIZE(chip->regs), chip->regs);
1114 dev_err(&client->dev, "Cannot get regulators\n");
1118 err = regulator_bulk_enable(ARRAY_SIZE(chip->regs), chip->regs);
1120 dev_err(&client->dev, "Cannot enable regulators\n");
1124 usleep_range(APDS_STARTUP_DELAY, 2 * APDS_STARTUP_DELAY);
1126 err = apds990x_detect(chip);
1128 dev_err(&client->dev, "APDS990X not found\n");
1132 pm_runtime_set_active(&client->dev);
1134 apds990x_configure(chip);
1135 apds990x_set_arate(chip, APDS_LUX_DEFAULT_RATE);
1136 apds990x_mode_on(chip);
1138 pm_runtime_enable(&client->dev);
1140 if (chip->pdata->setup_resources) {
1141 err = chip->pdata->setup_resources();
1148 err = sysfs_create_group(&chip->client->dev.kobj,
1149 apds990x_attribute_group);
1151 dev_err(&chip->client->dev, "Sysfs registration failed\n");
1155 err = request_threaded_irq(client->irq, NULL,
1157 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_LOW |
1161 dev_err(&client->dev, "could not get IRQ %d\n",
1167 sysfs_remove_group(&chip->client->dev.kobj,
1168 &apds990x_attribute_group[0]);
1170 if (chip->pdata && chip->pdata->release_resources)
1171 chip->pdata->release_resources();
1173 regulator_bulk_disable(ARRAY_SIZE(chip->regs), chip->regs);
1175 regulator_bulk_free(ARRAY_SIZE(chip->regs), chip->regs);
1181 static int apds990x_remove(struct i2c_client *client)
1183 struct apds990x_chip *chip = i2c_get_clientdata(client);
1185 free_irq(client->irq, chip);
1186 sysfs_remove_group(&chip->client->dev.kobj,
1187 apds990x_attribute_group);
1189 if (chip->pdata && chip->pdata->release_resources)
1190 chip->pdata->release_resources();
1192 if (!pm_runtime_suspended(&client->dev))
1193 apds990x_chip_off(chip);
1195 pm_runtime_disable(&client->dev);
1196 pm_runtime_set_suspended(&client->dev);
1198 regulator_bulk_free(ARRAY_SIZE(chip->regs), chip->regs);
1205 static int apds990x_suspend(struct device *dev)
1207 struct i2c_client *client = container_of(dev, struct i2c_client, dev);
1208 struct apds990x_chip *chip = i2c_get_clientdata(client);
1210 apds990x_chip_off(chip);
1214 static int apds990x_resume(struct device *dev)
1216 struct i2c_client *client = container_of(dev, struct i2c_client, dev);
1217 struct apds990x_chip *chip = i2c_get_clientdata(client);
1220 * If we were enabled at suspend time, it is expected
1221 * everything works nice and smoothly. Chip_on is enough
1223 apds990x_chip_on(chip);
1228 #define apds990x_suspend NULL
1229 #define apds990x_resume NULL
1230 #define apds990x_shutdown NULL
1233 #ifdef CONFIG_PM_RUNTIME
1234 static int apds990x_runtime_suspend(struct device *dev)
1236 struct i2c_client *client = container_of(dev, struct i2c_client, dev);
1237 struct apds990x_chip *chip = i2c_get_clientdata(client);
1239 apds990x_chip_off(chip);
1243 static int apds990x_runtime_resume(struct device *dev)
1245 struct i2c_client *client = container_of(dev, struct i2c_client, dev);
1246 struct apds990x_chip *chip = i2c_get_clientdata(client);
1248 apds990x_chip_on(chip);
1254 static const struct i2c_device_id apds990x_id[] = {
1259 MODULE_DEVICE_TABLE(i2c, apds990x_id);
1261 static const struct dev_pm_ops apds990x_pm_ops = {
1262 SET_SYSTEM_SLEEP_PM_OPS(apds990x_suspend, apds990x_resume)
1263 SET_RUNTIME_PM_OPS(apds990x_runtime_suspend,
1264 apds990x_runtime_resume,
1268 static struct i2c_driver apds990x_driver = {
1271 .owner = THIS_MODULE,
1272 .pm = &apds990x_pm_ops,
1274 .probe = apds990x_probe,
1275 .remove = apds990x_remove,
1276 .id_table = apds990x_id,
1279 module_i2c_driver(apds990x_driver);
1281 MODULE_DESCRIPTION("APDS990X combined ALS and proximity sensor");
1282 MODULE_AUTHOR("Samu Onkalo, Nokia Corporation");
1283 MODULE_LICENSE("GPL v2");