2 * This file is part of the ROHM BH1770GLC / OSRAM SFH7770 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/i2c/bh1770glc.h>
31 #include <linux/regulator/consumer.h>
32 #include <linux/pm_runtime.h>
33 #include <linux/workqueue.h>
34 #include <linux/delay.h>
35 #include <linux/wait.h>
36 #include <linux/slab.h>
38 #define BH1770_ALS_CONTROL 0x80 /* ALS operation mode control */
39 #define BH1770_PS_CONTROL 0x81 /* PS operation mode control */
40 #define BH1770_I_LED 0x82 /* active LED and LED1, LED2 current */
41 #define BH1770_I_LED3 0x83 /* LED3 current setting */
42 #define BH1770_ALS_PS_MEAS 0x84 /* Forced mode trigger */
43 #define BH1770_PS_MEAS_RATE 0x85 /* PS meas. rate at stand alone mode */
44 #define BH1770_ALS_MEAS_RATE 0x86 /* ALS meas. rate at stand alone mode */
45 #define BH1770_PART_ID 0x8a /* Part number and revision ID */
46 #define BH1770_MANUFACT_ID 0x8b /* Manufacturerer ID */
47 #define BH1770_ALS_DATA_0 0x8c /* ALS DATA low byte */
48 #define BH1770_ALS_DATA_1 0x8d /* ALS DATA high byte */
49 #define BH1770_ALS_PS_STATUS 0x8e /* Measurement data and int status */
50 #define BH1770_PS_DATA_LED1 0x8f /* PS data from LED1 */
51 #define BH1770_PS_DATA_LED2 0x90 /* PS data from LED2 */
52 #define BH1770_PS_DATA_LED3 0x91 /* PS data from LED3 */
53 #define BH1770_INTERRUPT 0x92 /* Interrupt setting */
54 #define BH1770_PS_TH_LED1 0x93 /* PS interrupt threshold for LED1 */
55 #define BH1770_PS_TH_LED2 0x94 /* PS interrupt threshold for LED2 */
56 #define BH1770_PS_TH_LED3 0x95 /* PS interrupt threshold for LED3 */
57 #define BH1770_ALS_TH_UP_0 0x96 /* ALS upper threshold low byte */
58 #define BH1770_ALS_TH_UP_1 0x97 /* ALS upper threshold high byte */
59 #define BH1770_ALS_TH_LOW_0 0x98 /* ALS lower threshold low byte */
60 #define BH1770_ALS_TH_LOW_1 0x99 /* ALS lower threshold high byte */
63 #define BH1770_MANUFACT_ROHM 0x01
64 #define BH1770_MANUFACT_OSRAM 0x03
67 #define BH1770_PART 0x90
68 #define BH1770_PART_MASK 0xf0
69 #define BH1770_REV_MASK 0x0f
70 #define BH1770_REV_SHIFT 0
71 #define BH1770_REV_0 0x00
72 #define BH1770_REV_1 0x01
74 /* Operating modes for both */
75 #define BH1770_STANDBY 0x00
76 #define BH1770_FORCED 0x02
77 #define BH1770_STANDALONE 0x03
78 #define BH1770_SWRESET (0x01 << 2)
80 #define BH1770_PS_TRIG_MEAS (1 << 0)
81 #define BH1770_ALS_TRIG_MEAS (1 << 1)
83 /* Interrupt control */
84 #define BH1770_INT_OUTPUT_MODE (1 << 3) /* 0 = latched */
85 #define BH1770_INT_POLARITY (1 << 2) /* 1 = active high */
86 #define BH1770_INT_ALS_ENA (1 << 1)
87 #define BH1770_INT_PS_ENA (1 << 0)
89 /* Interrupt status */
90 #define BH1770_INT_LED1_DATA (1 << 0)
91 #define BH1770_INT_LED1_INT (1 << 1)
92 #define BH1770_INT_LED2_DATA (1 << 2)
93 #define BH1770_INT_LED2_INT (1 << 3)
94 #define BH1770_INT_LED3_DATA (1 << 4)
95 #define BH1770_INT_LED3_INT (1 << 5)
96 #define BH1770_INT_LEDS_INT ((1 << 1) | (1 << 3) | (1 << 5))
97 #define BH1770_INT_ALS_DATA (1 << 6)
98 #define BH1770_INT_ALS_INT (1 << 7)
101 #define BH1770_LED1 0x00
103 #define BH1770_DISABLE 0
104 #define BH1770_ENABLE 1
105 #define BH1770_PROX_CHANNELS 1
107 #define BH1770_LUX_DEFAULT_RATE 1 /* Index to lux rate table */
108 #define BH1770_PROX_DEFAULT_RATE 1 /* Direct HW value =~ 50Hz */
109 #define BH1770_PROX_DEF_RATE_THRESH 6 /* Direct HW value =~ 5 Hz */
110 #define BH1770_STARTUP_DELAY 50
111 #define BH1770_RESET_TIME 10
112 #define BH1770_TIMEOUT 2100 /* Timeout in 2.1 seconds */
114 #define BH1770_LUX_RANGE 65535
115 #define BH1770_PROX_RANGE 255
116 #define BH1770_COEF_SCALER 1024
117 #define BH1770_CALIB_SCALER 8192
118 #define BH1770_LUX_NEUTRAL_CALIB_VALUE (1 * BH1770_CALIB_SCALER)
119 #define BH1770_LUX_DEF_THRES 1000
120 #define BH1770_PROX_DEF_THRES 70
121 #define BH1770_PROX_DEF_ABS_THRES 100
122 #define BH1770_DEFAULT_PERSISTENCE 10
123 #define BH1770_PROX_MAX_PERSISTENCE 50
124 #define BH1770_LUX_GA_SCALE 16384
125 #define BH1770_LUX_CF_SCALE 2048 /* CF ChipFactor */
126 #define BH1770_NEUTRAL_CF BH1770_LUX_CF_SCALE
127 #define BH1770_LUX_CORR_SCALE 4096
129 #define PROX_ABOVE_THRESHOLD 1
130 #define PROX_BELOW_THRESHOLD 0
132 #define PROX_IGNORE_LUX_LIMIT 500
135 struct bh1770_platform_data
*pdata
;
138 struct i2c_client
*client
;
139 struct regulator_bulk_data regs
[2];
140 struct mutex mutex
; /* avoid parallel access */
141 wait_queue_head_t wait
;
145 struct delayed_work prox_work
;
146 u32 lux_cf
; /* Chip specific factor */
152 u16 lux_threshold_hi
;
153 u16 lux_threshold_lo
;
154 u16 lux_thres_hi_onchip
;
155 u16 lux_thres_lo_onchip
;
156 bool lux_wait_result
;
158 int prox_enable_count
;
162 int prox_rate_threshold
;
164 u8 prox_persistence_counter
;
167 u8 prox_threshold_hw
;
168 bool prox_force_update
;
173 static const char reg_vcc
[] = "Vcc";
174 static const char reg_vleds
[] = "Vleds";
177 * Supported stand alone rates in ms from chip data sheet
178 * {10, 20, 30, 40, 70, 100, 200, 500, 1000, 2000};
180 static const s16 prox_rates_hz
[] = {100, 50, 33, 25, 14, 10, 5, 2};
181 static const s16 prox_rates_ms
[] = {10, 20, 30, 40, 70, 100, 200, 500};
183 /* Supported IR-led currents in mA */
184 static const u8 prox_curr_ma
[] = {5, 10, 20, 50, 100, 150, 200};
187 * Supported stand alone rates in ms from chip data sheet
188 * {100, 200, 500, 1000, 2000};
190 static const s16 lux_rates_hz
[] = {10, 5, 2, 1, 0};
193 * interrupt control functions are called while keeping chip->mutex
194 * excluding module probe / remove
196 static inline int bh1770_lux_interrupt_control(struct bh1770_chip
*chip
,
199 chip
->int_mode_lux
= lux
;
200 /* Set interrupt modes, interrupt active low, latched */
201 return i2c_smbus_write_byte_data(chip
->client
,
203 (lux
<< 1) | chip
->int_mode_prox
);
206 static inline int bh1770_prox_interrupt_control(struct bh1770_chip
*chip
,
209 chip
->int_mode_prox
= ps
;
210 return i2c_smbus_write_byte_data(chip
->client
,
212 (chip
->int_mode_lux
<< 1) | (ps
<< 0));
215 /* chip->mutex is always kept here */
216 static int bh1770_lux_rate(struct bh1770_chip
*chip
, int rate_index
)
218 /* sysfs may call this when the chip is powered off */
219 if (pm_runtime_suspended(&chip
->client
->dev
))
222 /* Proper proximity response needs fastest lux rate (100ms) */
223 if (chip
->prox_enable_count
)
226 return i2c_smbus_write_byte_data(chip
->client
,
227 BH1770_ALS_MEAS_RATE
,
231 static int bh1770_prox_rate(struct bh1770_chip
*chip
, int mode
)
235 rate
= (mode
== PROX_ABOVE_THRESHOLD
) ?
236 chip
->prox_rate_threshold
: chip
->prox_rate
;
238 return i2c_smbus_write_byte_data(chip
->client
,
243 /* InfraredLED is controlled by the chip during proximity scanning */
244 static inline int bh1770_led_cfg(struct bh1770_chip
*chip
)
246 /* LED cfg, current for leds 1 and 2 */
247 return i2c_smbus_write_byte_data(chip
->client
,
250 (BH1770_LED_5mA
<< 3) |
255 * Following two functions converts raw ps values from HW to normalized
256 * values. Purpose is to compensate differences between different sensor
257 * versions and variants so that result means about the same between
260 static inline u8
bh1770_psraw_to_adjusted(struct bh1770_chip
*chip
, u8 psraw
)
263 adjusted
= (u16
)(((u32
)(psraw
+ chip
->prox_const
) * chip
->prox_coef
) /
265 if (adjusted
> BH1770_PROX_RANGE
)
266 adjusted
= BH1770_PROX_RANGE
;
270 static inline u8
bh1770_psadjusted_to_raw(struct bh1770_chip
*chip
, u8 ps
)
274 raw
= (((u32
)ps
* BH1770_COEF_SCALER
) / chip
->prox_coef
);
275 if (raw
> chip
->prox_const
)
276 raw
= raw
- chip
->prox_const
;
283 * Following two functions converts raw lux values from HW to normalized
284 * values. Purpose is to compensate differences between different sensor
285 * versions and variants so that result means about the same between
286 * versions. Chip->mutex is kept when this is called.
288 static int bh1770_prox_set_threshold(struct bh1770_chip
*chip
)
292 /* sysfs may call this when the chip is powered off */
293 if (pm_runtime_suspended(&chip
->client
->dev
))
296 tmp
= bh1770_psadjusted_to_raw(chip
, chip
->prox_threshold
);
297 chip
->prox_threshold_hw
= tmp
;
299 return i2c_smbus_write_byte_data(chip
->client
, BH1770_PS_TH_LED1
,
303 static inline u16
bh1770_lux_raw_to_adjusted(struct bh1770_chip
*chip
, u16 raw
)
306 lux
= ((u32
)raw
* chip
->lux_corr
) / BH1770_LUX_CORR_SCALE
;
307 return min(lux
, (u32
)BH1770_LUX_RANGE
);
310 static inline u16
bh1770_lux_adjusted_to_raw(struct bh1770_chip
*chip
,
313 return (u32
)adjusted
* BH1770_LUX_CORR_SCALE
/ chip
->lux_corr
;
316 /* chip->mutex is kept when this is called */
317 static int bh1770_lux_update_thresholds(struct bh1770_chip
*chip
,
318 u16 threshold_hi
, u16 threshold_lo
)
323 /* sysfs may call this when the chip is powered off */
324 if (pm_runtime_suspended(&chip
->client
->dev
))
328 * Compensate threshold values with the correction factors if not
329 * set to minimum or maximum.
330 * Min & max values disables interrupts.
332 if (threshold_hi
!= BH1770_LUX_RANGE
&& threshold_hi
!= 0)
333 threshold_hi
= bh1770_lux_adjusted_to_raw(chip
, threshold_hi
);
335 if (threshold_lo
!= BH1770_LUX_RANGE
&& threshold_lo
!= 0)
336 threshold_lo
= bh1770_lux_adjusted_to_raw(chip
, threshold_lo
);
338 if (chip
->lux_thres_hi_onchip
== threshold_hi
&&
339 chip
->lux_thres_lo_onchip
== threshold_lo
)
342 chip
->lux_thres_hi_onchip
= threshold_hi
;
343 chip
->lux_thres_lo_onchip
= threshold_lo
;
345 data
[0] = threshold_hi
;
346 data
[1] = threshold_hi
>> 8;
347 data
[2] = threshold_lo
;
348 data
[3] = threshold_lo
>> 8;
350 ret
= i2c_smbus_write_i2c_block_data(chip
->client
,
357 static int bh1770_lux_get_result(struct bh1770_chip
*chip
)
362 ret
= i2c_smbus_read_byte_data(chip
->client
, BH1770_ALS_DATA_0
);
367 ret
= i2c_smbus_read_byte_data(chip
->client
, BH1770_ALS_DATA_1
);
371 chip
->lux_data_raw
= data
| ((ret
& 0xff) << 8);
376 /* Calculate correction value which contains chip and device specific parts */
377 static u32
bh1770_get_corr_value(struct bh1770_chip
*chip
)
380 /* Impact of glass attenuation correction */
381 tmp
= (BH1770_LUX_CORR_SCALE
* chip
->lux_ga
) / BH1770_LUX_GA_SCALE
;
382 /* Impact of chip factor correction */
383 tmp
= (tmp
* chip
->lux_cf
) / BH1770_LUX_CF_SCALE
;
384 /* Impact of Device specific calibration correction */
385 tmp
= (tmp
* chip
->lux_calib
) / BH1770_CALIB_SCALER
;
389 static int bh1770_lux_read_result(struct bh1770_chip
*chip
)
391 bh1770_lux_get_result(chip
);
392 return bh1770_lux_raw_to_adjusted(chip
, chip
->lux_data_raw
);
396 * Chip on / off functions are called while keeping mutex except probe
399 static int bh1770_chip_on(struct bh1770_chip
*chip
)
401 int ret
= regulator_bulk_enable(ARRAY_SIZE(chip
->regs
),
406 usleep_range(BH1770_STARTUP_DELAY
, BH1770_STARTUP_DELAY
* 2);
409 i2c_smbus_write_byte_data(chip
->client
, BH1770_ALS_CONTROL
,
411 usleep_range(BH1770_RESET_TIME
, BH1770_RESET_TIME
* 2);
414 * ALS is started always since proximity needs als results
415 * for realibility estimation.
416 * Let's assume dark until the first ALS measurement is ready.
418 chip
->lux_data_raw
= 0;
420 ret
= i2c_smbus_write_byte_data(chip
->client
,
421 BH1770_ALS_CONTROL
, BH1770_STANDALONE
);
423 /* Assume reset defaults */
424 chip
->lux_thres_hi_onchip
= BH1770_LUX_RANGE
;
425 chip
->lux_thres_lo_onchip
= 0;
430 static void bh1770_chip_off(struct bh1770_chip
*chip
)
432 i2c_smbus_write_byte_data(chip
->client
,
433 BH1770_INTERRUPT
, BH1770_DISABLE
);
434 i2c_smbus_write_byte_data(chip
->client
,
435 BH1770_ALS_CONTROL
, BH1770_STANDBY
);
436 i2c_smbus_write_byte_data(chip
->client
,
437 BH1770_PS_CONTROL
, BH1770_STANDBY
);
438 regulator_bulk_disable(ARRAY_SIZE(chip
->regs
), chip
->regs
);
441 /* chip->mutex is kept when this is called */
442 static int bh1770_prox_mode_control(struct bh1770_chip
*chip
)
444 if (chip
->prox_enable_count
) {
445 chip
->prox_force_update
= true; /* Force immediate update */
447 bh1770_lux_rate(chip
, chip
->lux_rate_index
);
448 bh1770_prox_set_threshold(chip
);
449 bh1770_led_cfg(chip
);
450 bh1770_prox_rate(chip
, PROX_BELOW_THRESHOLD
);
451 bh1770_prox_interrupt_control(chip
, BH1770_ENABLE
);
452 i2c_smbus_write_byte_data(chip
->client
,
453 BH1770_PS_CONTROL
, BH1770_STANDALONE
);
456 bh1770_lux_rate(chip
, chip
->lux_rate_index
);
457 bh1770_prox_interrupt_control(chip
, BH1770_DISABLE
);
458 i2c_smbus_write_byte_data(chip
->client
,
459 BH1770_PS_CONTROL
, BH1770_STANDBY
);
464 /* chip->mutex is kept when this is called */
465 static int bh1770_prox_read_result(struct bh1770_chip
*chip
)
471 ret
= i2c_smbus_read_byte_data(chip
->client
, BH1770_PS_DATA_LED1
);
475 if (ret
> chip
->prox_threshold_hw
)
481 * when ALS levels goes above limit, proximity result may be
482 * false proximity. Thus ignore the result. With real proximity
483 * there is a shadow causing low als levels.
485 if (chip
->lux_data_raw
> PROX_IGNORE_LUX_LIMIT
)
488 chip
->prox_data
= bh1770_psraw_to_adjusted(chip
, ret
);
490 /* Strong proximity level or force mode requires immediate response */
491 if (chip
->prox_data
>= chip
->prox_abs_thres
||
492 chip
->prox_force_update
)
493 chip
->prox_persistence_counter
= chip
->prox_persistence
;
495 chip
->prox_force_update
= false;
497 /* Persistence filttering to reduce false proximity events */
499 if (chip
->prox_persistence_counter
< chip
->prox_persistence
) {
500 chip
->prox_persistence_counter
++;
503 mode
= PROX_ABOVE_THRESHOLD
;
507 chip
->prox_persistence_counter
= 0;
508 mode
= PROX_BELOW_THRESHOLD
;
513 /* Set proximity detection rate based on above or below value */
515 bh1770_prox_rate(chip
, mode
);
516 sysfs_notify(&chip
->client
->dev
.kobj
, NULL
, "prox0_raw");
522 static int bh1770_detect(struct bh1770_chip
*chip
)
524 struct i2c_client
*client
= chip
->client
;
528 ret
= i2c_smbus_read_byte_data(client
, BH1770_MANUFACT_ID
);
533 ret
= i2c_smbus_read_byte_data(client
, BH1770_PART_ID
);
538 chip
->revision
= (part
& BH1770_REV_MASK
) >> BH1770_REV_SHIFT
;
539 chip
->prox_coef
= BH1770_COEF_SCALER
;
540 chip
->prox_const
= 0;
541 chip
->lux_cf
= BH1770_NEUTRAL_CF
;
543 if ((manu
== BH1770_MANUFACT_ROHM
) &&
544 ((part
& BH1770_PART_MASK
) == BH1770_PART
)) {
545 snprintf(chip
->chipname
, sizeof(chip
->chipname
), "BH1770GLC");
549 if ((manu
== BH1770_MANUFACT_OSRAM
) &&
550 ((part
& BH1770_PART_MASK
) == BH1770_PART
)) {
551 snprintf(chip
->chipname
, sizeof(chip
->chipname
), "SFH7770");
552 /* Values selected by comparing different versions */
553 chip
->prox_coef
= 819; /* 0.8 * BH1770_COEF_SCALER */
554 chip
->prox_const
= 40;
560 dev_dbg(&client
->dev
, "BH1770 or SFH7770 not found\n");
566 * This work is re-scheduled at every proximity interrupt.
567 * If this work is running, it means that there hasn't been any
568 * proximity interrupt in time. Situation is handled as no-proximity.
569 * It would be nice to have low-threshold interrupt or interrupt
570 * when measurement and hi-threshold are both 0. But neither of those exists.
571 * This is a workaroud for missing HW feature.
574 static void bh1770_prox_work(struct work_struct
*work
)
576 struct bh1770_chip
*chip
=
577 container_of(work
, struct bh1770_chip
, prox_work
.work
);
579 mutex_lock(&chip
->mutex
);
580 bh1770_prox_read_result(chip
);
581 mutex_unlock(&chip
->mutex
);
584 /* This is threaded irq handler */
585 static irqreturn_t
bh1770_irq(int irq
, void *data
)
587 struct bh1770_chip
*chip
= data
;
591 mutex_lock(&chip
->mutex
);
592 status
= i2c_smbus_read_byte_data(chip
->client
, BH1770_ALS_PS_STATUS
);
594 /* Acknowledge interrupt by reading this register */
595 i2c_smbus_read_byte_data(chip
->client
, BH1770_INTERRUPT
);
598 * Check if there is fresh data available for als.
599 * If this is the very first data, update thresholds after that.
601 if (status
& BH1770_INT_ALS_DATA
) {
602 bh1770_lux_get_result(chip
);
603 if (unlikely(chip
->lux_wait_result
)) {
604 chip
->lux_wait_result
= false;
605 wake_up(&chip
->wait
);
606 bh1770_lux_update_thresholds(chip
,
607 chip
->lux_threshold_hi
,
608 chip
->lux_threshold_lo
);
612 /* Disable interrupt logic to guarantee acknowledgement */
613 i2c_smbus_write_byte_data(chip
->client
, BH1770_INTERRUPT
,
614 (0 << 1) | (0 << 0));
616 if ((status
& BH1770_INT_ALS_INT
))
617 sysfs_notify(&chip
->client
->dev
.kobj
, NULL
, "lux0_input");
619 if (chip
->int_mode_prox
&& (status
& BH1770_INT_LEDS_INT
)) {
620 rate
= prox_rates_ms
[chip
->prox_rate_threshold
];
621 bh1770_prox_read_result(chip
);
624 /* Re-enable interrupt logic */
625 i2c_smbus_write_byte_data(chip
->client
, BH1770_INTERRUPT
,
626 (chip
->int_mode_lux
<< 1) |
627 (chip
->int_mode_prox
<< 0));
628 mutex_unlock(&chip
->mutex
);
631 * Can't cancel work while keeping mutex since the work uses the
636 * Simulate missing no-proximity interrupt 50ms after the
637 * next expected interrupt time.
639 cancel_delayed_work_sync(&chip
->prox_work
);
640 schedule_delayed_work(&chip
->prox_work
,
641 msecs_to_jiffies(rate
+ 50));
646 static ssize_t
bh1770_power_state_store(struct device
*dev
,
647 struct device_attribute
*attr
,
648 const char *buf
, size_t count
)
650 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
654 ret
= kstrtoul(buf
, 0, &value
);
658 mutex_lock(&chip
->mutex
);
660 pm_runtime_get_sync(dev
);
662 ret
= bh1770_lux_rate(chip
, chip
->lux_rate_index
);
668 ret
= bh1770_lux_interrupt_control(chip
, BH1770_ENABLE
);
674 /* This causes interrupt after the next measurement cycle */
675 bh1770_lux_update_thresholds(chip
, BH1770_LUX_DEF_THRES
,
676 BH1770_LUX_DEF_THRES
);
677 /* Inform that we are waiting for a result from ALS */
678 chip
->lux_wait_result
= true;
679 bh1770_prox_mode_control(chip
);
680 } else if (!pm_runtime_suspended(dev
)) {
685 mutex_unlock(&chip
->mutex
);
689 static ssize_t
bh1770_power_state_show(struct device
*dev
,
690 struct device_attribute
*attr
, char *buf
)
692 return sprintf(buf
, "%d\n", !pm_runtime_suspended(dev
));
695 static ssize_t
bh1770_lux_result_show(struct device
*dev
,
696 struct device_attribute
*attr
, char *buf
)
698 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
702 if (pm_runtime_suspended(dev
))
703 return -EIO
; /* Chip is not enabled at all */
705 timeout
= wait_event_interruptible_timeout(chip
->wait
,
706 !chip
->lux_wait_result
,
707 msecs_to_jiffies(BH1770_TIMEOUT
));
711 mutex_lock(&chip
->mutex
);
712 ret
= sprintf(buf
, "%d\n", bh1770_lux_read_result(chip
));
713 mutex_unlock(&chip
->mutex
);
718 static ssize_t
bh1770_lux_range_show(struct device
*dev
,
719 struct device_attribute
*attr
, char *buf
)
721 return sprintf(buf
, "%d\n", BH1770_LUX_RANGE
);
724 static ssize_t
bh1770_prox_enable_store(struct device
*dev
,
725 struct device_attribute
*attr
,
726 const char *buf
, size_t count
)
728 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
732 ret
= kstrtoul(buf
, 0, &value
);
736 mutex_lock(&chip
->mutex
);
737 /* Assume no proximity. Sensor will tell real state soon */
738 if (!chip
->prox_enable_count
)
742 chip
->prox_enable_count
++;
743 else if (chip
->prox_enable_count
> 0)
744 chip
->prox_enable_count
--;
748 /* Run control only when chip is powered on */
749 if (!pm_runtime_suspended(dev
))
750 bh1770_prox_mode_control(chip
);
752 mutex_unlock(&chip
->mutex
);
756 static ssize_t
bh1770_prox_enable_show(struct device
*dev
,
757 struct device_attribute
*attr
, char *buf
)
759 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
762 mutex_lock(&chip
->mutex
);
763 len
= sprintf(buf
, "%d\n", chip
->prox_enable_count
);
764 mutex_unlock(&chip
->mutex
);
768 static ssize_t
bh1770_prox_result_show(struct device
*dev
,
769 struct device_attribute
*attr
, char *buf
)
771 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
774 mutex_lock(&chip
->mutex
);
775 if (chip
->prox_enable_count
&& !pm_runtime_suspended(dev
))
776 ret
= sprintf(buf
, "%d\n", chip
->prox_data
);
779 mutex_unlock(&chip
->mutex
);
783 static ssize_t
bh1770_prox_range_show(struct device
*dev
,
784 struct device_attribute
*attr
, char *buf
)
786 return sprintf(buf
, "%d\n", BH1770_PROX_RANGE
);
789 static ssize_t
bh1770_get_prox_rate_avail(struct device
*dev
,
790 struct device_attribute
*attr
, char *buf
)
794 for (i
= 0; i
< ARRAY_SIZE(prox_rates_hz
); i
++)
795 pos
+= sprintf(buf
+ pos
, "%d ", prox_rates_hz
[i
]);
796 sprintf(buf
+ pos
- 1, "\n");
800 static ssize_t
bh1770_get_prox_rate_above(struct device
*dev
,
801 struct device_attribute
*attr
, char *buf
)
803 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
804 return sprintf(buf
, "%d\n", prox_rates_hz
[chip
->prox_rate_threshold
]);
807 static ssize_t
bh1770_get_prox_rate_below(struct device
*dev
,
808 struct device_attribute
*attr
, char *buf
)
810 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
811 return sprintf(buf
, "%d\n", prox_rates_hz
[chip
->prox_rate
]);
814 static int bh1770_prox_rate_validate(int rate
)
818 for (i
= 0; i
< ARRAY_SIZE(prox_rates_hz
) - 1; i
++)
819 if (rate
>= prox_rates_hz
[i
])
824 static ssize_t
bh1770_set_prox_rate_above(struct device
*dev
,
825 struct device_attribute
*attr
,
826 const char *buf
, size_t count
)
828 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
832 ret
= kstrtoul(buf
, 0, &value
);
836 mutex_lock(&chip
->mutex
);
837 chip
->prox_rate_threshold
= bh1770_prox_rate_validate(value
);
838 mutex_unlock(&chip
->mutex
);
842 static ssize_t
bh1770_set_prox_rate_below(struct device
*dev
,
843 struct device_attribute
*attr
,
844 const char *buf
, size_t count
)
846 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
850 ret
= kstrtoul(buf
, 0, &value
);
854 mutex_lock(&chip
->mutex
);
855 chip
->prox_rate
= bh1770_prox_rate_validate(value
);
856 mutex_unlock(&chip
->mutex
);
860 static ssize_t
bh1770_get_prox_thres(struct device
*dev
,
861 struct device_attribute
*attr
, char *buf
)
863 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
864 return sprintf(buf
, "%d\n", chip
->prox_threshold
);
867 static ssize_t
bh1770_set_prox_thres(struct device
*dev
,
868 struct device_attribute
*attr
,
869 const char *buf
, size_t count
)
871 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
875 ret
= kstrtoul(buf
, 0, &value
);
879 if (value
> BH1770_PROX_RANGE
)
882 mutex_lock(&chip
->mutex
);
883 chip
->prox_threshold
= value
;
884 ret
= bh1770_prox_set_threshold(chip
);
885 mutex_unlock(&chip
->mutex
);
891 static ssize_t
bh1770_prox_persistence_show(struct device
*dev
,
892 struct device_attribute
*attr
, char *buf
)
894 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
896 return sprintf(buf
, "%u\n", chip
->prox_persistence
);
899 static ssize_t
bh1770_prox_persistence_store(struct device
*dev
,
900 struct device_attribute
*attr
,
901 const char *buf
, size_t len
)
903 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
907 ret
= kstrtoul(buf
, 0, &value
);
911 if (value
> BH1770_PROX_MAX_PERSISTENCE
)
914 chip
->prox_persistence
= value
;
919 static ssize_t
bh1770_prox_abs_thres_show(struct device
*dev
,
920 struct device_attribute
*attr
, char *buf
)
922 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
923 return sprintf(buf
, "%u\n", chip
->prox_abs_thres
);
926 static ssize_t
bh1770_prox_abs_thres_store(struct device
*dev
,
927 struct device_attribute
*attr
,
928 const char *buf
, size_t len
)
930 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
934 ret
= kstrtoul(buf
, 0, &value
);
938 if (value
> BH1770_PROX_RANGE
)
941 chip
->prox_abs_thres
= value
;
946 static ssize_t
bh1770_chip_id_show(struct device
*dev
,
947 struct device_attribute
*attr
, char *buf
)
949 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
950 return sprintf(buf
, "%s rev %d\n", chip
->chipname
, chip
->revision
);
953 static ssize_t
bh1770_lux_calib_default_show(struct device
*dev
,
954 struct device_attribute
*attr
, char *buf
)
956 return sprintf(buf
, "%u\n", BH1770_CALIB_SCALER
);
959 static ssize_t
bh1770_lux_calib_show(struct device
*dev
,
960 struct device_attribute
*attr
, char *buf
)
962 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
965 mutex_lock(&chip
->mutex
);
966 len
= sprintf(buf
, "%u\n", chip
->lux_calib
);
967 mutex_unlock(&chip
->mutex
);
971 static ssize_t
bh1770_lux_calib_store(struct device
*dev
,
972 struct device_attribute
*attr
,
973 const char *buf
, size_t len
)
975 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
981 ret
= kstrtoul(buf
, 0, &value
);
985 mutex_lock(&chip
->mutex
);
986 old_calib
= chip
->lux_calib
;
987 chip
->lux_calib
= value
;
988 new_corr
= bh1770_get_corr_value(chip
);
990 chip
->lux_calib
= old_calib
;
991 mutex_unlock(&chip
->mutex
);
994 chip
->lux_corr
= new_corr
;
995 /* Refresh thresholds on HW after changing correction value */
996 bh1770_lux_update_thresholds(chip
, chip
->lux_threshold_hi
,
997 chip
->lux_threshold_lo
);
999 mutex_unlock(&chip
->mutex
);
1004 static ssize_t
bh1770_get_lux_rate_avail(struct device
*dev
,
1005 struct device_attribute
*attr
, char *buf
)
1009 for (i
= 0; i
< ARRAY_SIZE(lux_rates_hz
); i
++)
1010 pos
+= sprintf(buf
+ pos
, "%d ", lux_rates_hz
[i
]);
1011 sprintf(buf
+ pos
- 1, "\n");
1015 static ssize_t
bh1770_get_lux_rate(struct device
*dev
,
1016 struct device_attribute
*attr
, char *buf
)
1018 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
1019 return sprintf(buf
, "%d\n", lux_rates_hz
[chip
->lux_rate_index
]);
1022 static ssize_t
bh1770_set_lux_rate(struct device
*dev
,
1023 struct device_attribute
*attr
,
1024 const char *buf
, size_t count
)
1026 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
1027 unsigned long rate_hz
;
1030 ret
= kstrtoul(buf
, 0, &rate_hz
);
1034 for (i
= 0; i
< ARRAY_SIZE(lux_rates_hz
) - 1; i
++)
1035 if (rate_hz
>= lux_rates_hz
[i
])
1038 mutex_lock(&chip
->mutex
);
1039 chip
->lux_rate_index
= i
;
1040 ret
= bh1770_lux_rate(chip
, i
);
1041 mutex_unlock(&chip
->mutex
);
1049 static ssize_t
bh1770_get_lux_thresh_above(struct device
*dev
,
1050 struct device_attribute
*attr
, char *buf
)
1052 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
1053 return sprintf(buf
, "%d\n", chip
->lux_threshold_hi
);
1056 static ssize_t
bh1770_get_lux_thresh_below(struct device
*dev
,
1057 struct device_attribute
*attr
, char *buf
)
1059 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
1060 return sprintf(buf
, "%d\n", chip
->lux_threshold_lo
);
1063 static ssize_t
bh1770_set_lux_thresh(struct bh1770_chip
*chip
, u16
*target
,
1066 unsigned long thresh
;
1069 ret
= kstrtoul(buf
, 0, &thresh
);
1073 if (thresh
> BH1770_LUX_RANGE
)
1076 mutex_lock(&chip
->mutex
);
1079 * Don't update values in HW if we are still waiting for
1080 * first interrupt to come after device handle open call.
1082 if (!chip
->lux_wait_result
)
1083 ret
= bh1770_lux_update_thresholds(chip
,
1084 chip
->lux_threshold_hi
,
1085 chip
->lux_threshold_lo
);
1086 mutex_unlock(&chip
->mutex
);
1091 static ssize_t
bh1770_set_lux_thresh_above(struct device
*dev
,
1092 struct device_attribute
*attr
,
1093 const char *buf
, size_t len
)
1095 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
1096 int ret
= bh1770_set_lux_thresh(chip
, &chip
->lux_threshold_hi
, buf
);
1102 static ssize_t
bh1770_set_lux_thresh_below(struct device
*dev
,
1103 struct device_attribute
*attr
,
1104 const char *buf
, size_t len
)
1106 struct bh1770_chip
*chip
= dev_get_drvdata(dev
);
1107 int ret
= bh1770_set_lux_thresh(chip
, &chip
->lux_threshold_lo
, buf
);
1113 static DEVICE_ATTR(prox0_raw_en
, S_IRUGO
| S_IWUSR
, bh1770_prox_enable_show
,
1114 bh1770_prox_enable_store
);
1115 static DEVICE_ATTR(prox0_thresh_above1_value
, S_IRUGO
| S_IWUSR
,
1116 bh1770_prox_abs_thres_show
,
1117 bh1770_prox_abs_thres_store
);
1118 static DEVICE_ATTR(prox0_thresh_above0_value
, S_IRUGO
| S_IWUSR
,
1119 bh1770_get_prox_thres
,
1120 bh1770_set_prox_thres
);
1121 static DEVICE_ATTR(prox0_raw
, S_IRUGO
, bh1770_prox_result_show
, NULL
);
1122 static DEVICE_ATTR(prox0_sensor_range
, S_IRUGO
, bh1770_prox_range_show
, NULL
);
1123 static DEVICE_ATTR(prox0_thresh_above_count
, S_IRUGO
| S_IWUSR
,
1124 bh1770_prox_persistence_show
,
1125 bh1770_prox_persistence_store
);
1126 static DEVICE_ATTR(prox0_rate_above
, S_IRUGO
| S_IWUSR
,
1127 bh1770_get_prox_rate_above
,
1128 bh1770_set_prox_rate_above
);
1129 static DEVICE_ATTR(prox0_rate_below
, S_IRUGO
| S_IWUSR
,
1130 bh1770_get_prox_rate_below
,
1131 bh1770_set_prox_rate_below
);
1132 static DEVICE_ATTR(prox0_rate_avail
, S_IRUGO
, bh1770_get_prox_rate_avail
, NULL
);
1134 static DEVICE_ATTR(lux0_calibscale
, S_IRUGO
| S_IWUSR
, bh1770_lux_calib_show
,
1135 bh1770_lux_calib_store
);
1136 static DEVICE_ATTR(lux0_calibscale_default
, S_IRUGO
,
1137 bh1770_lux_calib_default_show
,
1139 static DEVICE_ATTR(lux0_input
, S_IRUGO
, bh1770_lux_result_show
, NULL
);
1140 static DEVICE_ATTR(lux0_sensor_range
, S_IRUGO
, bh1770_lux_range_show
, NULL
);
1141 static DEVICE_ATTR(lux0_rate
, S_IRUGO
| S_IWUSR
, bh1770_get_lux_rate
,
1142 bh1770_set_lux_rate
);
1143 static DEVICE_ATTR(lux0_rate_avail
, S_IRUGO
, bh1770_get_lux_rate_avail
, NULL
);
1144 static DEVICE_ATTR(lux0_thresh_above_value
, S_IRUGO
| S_IWUSR
,
1145 bh1770_get_lux_thresh_above
,
1146 bh1770_set_lux_thresh_above
);
1147 static DEVICE_ATTR(lux0_thresh_below_value
, S_IRUGO
| S_IWUSR
,
1148 bh1770_get_lux_thresh_below
,
1149 bh1770_set_lux_thresh_below
);
1150 static DEVICE_ATTR(chip_id
, S_IRUGO
, bh1770_chip_id_show
, NULL
);
1151 static DEVICE_ATTR(power_state
, S_IRUGO
| S_IWUSR
, bh1770_power_state_show
,
1152 bh1770_power_state_store
);
1155 static struct attribute
*sysfs_attrs
[] = {
1156 &dev_attr_lux0_calibscale
.attr
,
1157 &dev_attr_lux0_calibscale_default
.attr
,
1158 &dev_attr_lux0_input
.attr
,
1159 &dev_attr_lux0_sensor_range
.attr
,
1160 &dev_attr_lux0_rate
.attr
,
1161 &dev_attr_lux0_rate_avail
.attr
,
1162 &dev_attr_lux0_thresh_above_value
.attr
,
1163 &dev_attr_lux0_thresh_below_value
.attr
,
1164 &dev_attr_prox0_raw
.attr
,
1165 &dev_attr_prox0_sensor_range
.attr
,
1166 &dev_attr_prox0_raw_en
.attr
,
1167 &dev_attr_prox0_thresh_above_count
.attr
,
1168 &dev_attr_prox0_rate_above
.attr
,
1169 &dev_attr_prox0_rate_below
.attr
,
1170 &dev_attr_prox0_rate_avail
.attr
,
1171 &dev_attr_prox0_thresh_above0_value
.attr
,
1172 &dev_attr_prox0_thresh_above1_value
.attr
,
1173 &dev_attr_chip_id
.attr
,
1174 &dev_attr_power_state
.attr
,
1178 static struct attribute_group bh1770_attribute_group
= {
1179 .attrs
= sysfs_attrs
1182 static int bh1770_probe(struct i2c_client
*client
,
1183 const struct i2c_device_id
*id
)
1185 struct bh1770_chip
*chip
;
1188 chip
= devm_kzalloc(&client
->dev
, sizeof *chip
, GFP_KERNEL
);
1192 i2c_set_clientdata(client
, chip
);
1193 chip
->client
= client
;
1195 mutex_init(&chip
->mutex
);
1196 init_waitqueue_head(&chip
->wait
);
1197 INIT_DELAYED_WORK(&chip
->prox_work
, bh1770_prox_work
);
1199 if (client
->dev
.platform_data
== NULL
) {
1200 dev_err(&client
->dev
, "platform data is mandatory\n");
1204 chip
->pdata
= client
->dev
.platform_data
;
1205 chip
->lux_calib
= BH1770_LUX_NEUTRAL_CALIB_VALUE
;
1206 chip
->lux_rate_index
= BH1770_LUX_DEFAULT_RATE
;
1207 chip
->lux_threshold_lo
= BH1770_LUX_DEF_THRES
;
1208 chip
->lux_threshold_hi
= BH1770_LUX_DEF_THRES
;
1210 if (chip
->pdata
->glass_attenuation
== 0)
1211 chip
->lux_ga
= BH1770_NEUTRAL_GA
;
1213 chip
->lux_ga
= chip
->pdata
->glass_attenuation
;
1215 chip
->prox_threshold
= BH1770_PROX_DEF_THRES
;
1216 chip
->prox_led
= chip
->pdata
->led_def_curr
;
1217 chip
->prox_abs_thres
= BH1770_PROX_DEF_ABS_THRES
;
1218 chip
->prox_persistence
= BH1770_DEFAULT_PERSISTENCE
;
1219 chip
->prox_rate_threshold
= BH1770_PROX_DEF_RATE_THRESH
;
1220 chip
->prox_rate
= BH1770_PROX_DEFAULT_RATE
;
1221 chip
->prox_data
= 0;
1223 chip
->regs
[0].supply
= reg_vcc
;
1224 chip
->regs
[1].supply
= reg_vleds
;
1226 err
= devm_regulator_bulk_get(&client
->dev
,
1227 ARRAY_SIZE(chip
->regs
), chip
->regs
);
1229 dev_err(&client
->dev
, "Cannot get regulators\n");
1233 err
= regulator_bulk_enable(ARRAY_SIZE(chip
->regs
),
1236 dev_err(&client
->dev
, "Cannot enable regulators\n");
1240 usleep_range(BH1770_STARTUP_DELAY
, BH1770_STARTUP_DELAY
* 2);
1241 err
= bh1770_detect(chip
);
1246 bh1770_chip_on(chip
);
1247 pm_runtime_set_active(&client
->dev
);
1248 pm_runtime_enable(&client
->dev
);
1250 chip
->lux_corr
= bh1770_get_corr_value(chip
);
1251 if (chip
->lux_corr
== 0) {
1252 dev_err(&client
->dev
, "Improper correction values\n");
1257 if (chip
->pdata
->setup_resources
) {
1258 err
= chip
->pdata
->setup_resources();
1265 err
= sysfs_create_group(&chip
->client
->dev
.kobj
,
1266 &bh1770_attribute_group
);
1268 dev_err(&chip
->client
->dev
, "Sysfs registration failed\n");
1273 * Chip needs level triggered interrupt to work. However,
1274 * level triggering doesn't work always correctly with power
1275 * management. Select both
1277 err
= request_threaded_irq(client
->irq
, NULL
,
1279 IRQF_TRIGGER_FALLING
| IRQF_ONESHOT
|
1283 dev_err(&client
->dev
, "could not get IRQ %d\n",
1287 regulator_bulk_disable(ARRAY_SIZE(chip
->regs
), chip
->regs
);
1290 sysfs_remove_group(&chip
->client
->dev
.kobj
,
1291 &bh1770_attribute_group
);
1293 if (chip
->pdata
->release_resources
)
1294 chip
->pdata
->release_resources();
1296 regulator_bulk_disable(ARRAY_SIZE(chip
->regs
), chip
->regs
);
1300 static int bh1770_remove(struct i2c_client
*client
)
1302 struct bh1770_chip
*chip
= i2c_get_clientdata(client
);
1304 free_irq(client
->irq
, chip
);
1306 sysfs_remove_group(&chip
->client
->dev
.kobj
,
1307 &bh1770_attribute_group
);
1309 if (chip
->pdata
->release_resources
)
1310 chip
->pdata
->release_resources();
1312 cancel_delayed_work_sync(&chip
->prox_work
);
1314 if (!pm_runtime_suspended(&client
->dev
))
1315 bh1770_chip_off(chip
);
1317 pm_runtime_disable(&client
->dev
);
1318 pm_runtime_set_suspended(&client
->dev
);
1323 #ifdef CONFIG_PM_SLEEP
1324 static int bh1770_suspend(struct device
*dev
)
1326 struct i2c_client
*client
= to_i2c_client(dev
);
1327 struct bh1770_chip
*chip
= i2c_get_clientdata(client
);
1329 bh1770_chip_off(chip
);
1334 static int bh1770_resume(struct device
*dev
)
1336 struct i2c_client
*client
= to_i2c_client(dev
);
1337 struct bh1770_chip
*chip
= i2c_get_clientdata(client
);
1340 bh1770_chip_on(chip
);
1342 if (!pm_runtime_suspended(dev
)) {
1344 * If we were enabled at suspend time, it is expected
1345 * everything works nice and smoothly
1347 ret
= bh1770_lux_rate(chip
, chip
->lux_rate_index
);
1348 ret
|= bh1770_lux_interrupt_control(chip
, BH1770_ENABLE
);
1350 /* This causes interrupt after the next measurement cycle */
1351 bh1770_lux_update_thresholds(chip
, BH1770_LUX_DEF_THRES
,
1352 BH1770_LUX_DEF_THRES
);
1353 /* Inform that we are waiting for a result from ALS */
1354 chip
->lux_wait_result
= true;
1355 bh1770_prox_mode_control(chip
);
1362 static int bh1770_runtime_suspend(struct device
*dev
)
1364 struct i2c_client
*client
= to_i2c_client(dev
);
1365 struct bh1770_chip
*chip
= i2c_get_clientdata(client
);
1367 bh1770_chip_off(chip
);
1372 static int bh1770_runtime_resume(struct device
*dev
)
1374 struct i2c_client
*client
= to_i2c_client(dev
);
1375 struct bh1770_chip
*chip
= i2c_get_clientdata(client
);
1377 bh1770_chip_on(chip
);
1383 static const struct i2c_device_id bh1770_id
[] = {
1389 MODULE_DEVICE_TABLE(i2c
, bh1770_id
);
1391 static const struct dev_pm_ops bh1770_pm_ops
= {
1392 SET_SYSTEM_SLEEP_PM_OPS(bh1770_suspend
, bh1770_resume
)
1393 SET_RUNTIME_PM_OPS(bh1770_runtime_suspend
, bh1770_runtime_resume
, NULL
)
1396 static struct i2c_driver bh1770_driver
= {
1398 .name
= "bh1770glc",
1399 .pm
= &bh1770_pm_ops
,
1401 .probe
= bh1770_probe
,
1402 .remove
= bh1770_remove
,
1403 .id_table
= bh1770_id
,
1406 module_i2c_driver(bh1770_driver
);
1408 MODULE_DESCRIPTION("BH1770GLC / SFH7770 combined ALS and proximity sensor");
1409 MODULE_AUTHOR("Samu Onkalo, Nokia Corporation");
1410 MODULE_LICENSE("GPL v2");