2 * drivers/i2c/chips/tsl2563.c
4 * Copyright (C) 2008 Nokia Corporation
6 * Written by Timo O. Karjalainen <timo.o.karjalainen@nokia.com>
7 * Contact: Amit Kucheria <amit.kucheria@verdurent.com>
9 * Converted to IIO driver
10 * Amit Kucheria <amit.kucheria@verdurent.com>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * version 2 as published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
27 #include <linux/module.h>
28 #include <linux/i2c.h>
29 #include <linux/interrupt.h>
30 #include <linux/irq.h>
31 #include <linux/sched.h>
32 #include <linux/mutex.h>
33 #include <linux/delay.h>
35 #include <linux/err.h>
36 #include <linux/slab.h>
40 #include "../events.h"
43 /* Use this many bits for fraction part. */
44 #define ADC_FRAC_BITS (14)
46 /* Given number of 1/10000's in ADC_FRAC_BITS precision. */
47 #define FRAC10K(f) (((f) * (1L << (ADC_FRAC_BITS))) / (10000))
49 /* Bits used for fraction in calibration coefficients.*/
50 #define CALIB_FRAC_BITS (10)
51 /* 0.5 in CALIB_FRAC_BITS precision */
52 #define CALIB_FRAC_HALF (1 << (CALIB_FRAC_BITS - 1))
53 /* Make a fraction from a number n that was multiplied with b. */
54 #define CALIB_FRAC(n, b) (((n) << CALIB_FRAC_BITS) / (b))
55 /* Decimal 10^(digits in sysfs presentation) */
56 #define CALIB_BASE_SYSFS (1000)
58 #define TSL2563_CMD (0x80)
59 #define TSL2563_CLEARINT (0x40)
61 #define TSL2563_REG_CTRL (0x00)
62 #define TSL2563_REG_TIMING (0x01)
63 #define TSL2563_REG_LOWLOW (0x02) /* data0 low threshold, 2 bytes */
64 #define TSL2563_REG_LOWHIGH (0x03)
65 #define TSL2563_REG_HIGHLOW (0x04) /* data0 high threshold, 2 bytes */
66 #define TSL2563_REG_HIGHHIGH (0x05)
67 #define TSL2563_REG_INT (0x06)
68 #define TSL2563_REG_ID (0x0a)
69 #define TSL2563_REG_DATA0LOW (0x0c) /* broadband sensor value, 2 bytes */
70 #define TSL2563_REG_DATA0HIGH (0x0d)
71 #define TSL2563_REG_DATA1LOW (0x0e) /* infrared sensor value, 2 bytes */
72 #define TSL2563_REG_DATA1HIGH (0x0f)
74 #define TSL2563_CMD_POWER_ON (0x03)
75 #define TSL2563_CMD_POWER_OFF (0x00)
76 #define TSL2563_CTRL_POWER_MASK (0x03)
78 #define TSL2563_TIMING_13MS (0x00)
79 #define TSL2563_TIMING_100MS (0x01)
80 #define TSL2563_TIMING_400MS (0x02)
81 #define TSL2563_TIMING_MASK (0x03)
82 #define TSL2563_TIMING_GAIN16 (0x10)
83 #define TSL2563_TIMING_GAIN1 (0x00)
85 #define TSL2563_INT_DISBLED (0x00)
86 #define TSL2563_INT_LEVEL (0x10)
87 #define TSL2563_INT_PERSIST(n) ((n) & 0x0F)
89 struct tsl2563_gainlevel_coeff
{
95 static const struct tsl2563_gainlevel_coeff tsl2563_gainlevel_table
[] = {
97 .gaintime
= TSL2563_TIMING_400MS
| TSL2563_TIMING_GAIN16
,
101 .gaintime
= TSL2563_TIMING_400MS
| TSL2563_TIMING_GAIN1
,
105 .gaintime
= TSL2563_TIMING_100MS
| TSL2563_TIMING_GAIN1
,
109 .gaintime
= TSL2563_TIMING_13MS
| TSL2563_TIMING_GAIN1
,
115 struct tsl2563_chip
{
117 struct i2c_client
*client
;
118 struct delayed_work poweroff_work
;
120 /* Remember state for suspend and resume functions */
123 struct tsl2563_gainlevel_coeff
const *gainlevel
;
130 /* Calibration coefficients */
135 /* Cache current values, to be returned while suspended */
140 static int tsl2563_set_power(struct tsl2563_chip
*chip
, int on
)
142 struct i2c_client
*client
= chip
->client
;
145 cmd
= on
? TSL2563_CMD_POWER_ON
: TSL2563_CMD_POWER_OFF
;
146 return i2c_smbus_write_byte_data(client
,
147 TSL2563_CMD
| TSL2563_REG_CTRL
, cmd
);
151 * Return value is 0 for off, 1 for on, or a negative error
152 * code if reading failed.
154 static int tsl2563_get_power(struct tsl2563_chip
*chip
)
156 struct i2c_client
*client
= chip
->client
;
159 ret
= i2c_smbus_read_byte_data(client
, TSL2563_CMD
| TSL2563_REG_CTRL
);
163 return (ret
& TSL2563_CTRL_POWER_MASK
) == TSL2563_CMD_POWER_ON
;
166 static int tsl2563_configure(struct tsl2563_chip
*chip
)
170 ret
= i2c_smbus_write_byte_data(chip
->client
,
171 TSL2563_CMD
| TSL2563_REG_TIMING
,
172 chip
->gainlevel
->gaintime
);
175 ret
= i2c_smbus_write_byte_data(chip
->client
,
176 TSL2563_CMD
| TSL2563_REG_HIGHLOW
,
177 chip
->high_thres
& 0xFF);
180 ret
= i2c_smbus_write_byte_data(chip
->client
,
181 TSL2563_CMD
| TSL2563_REG_HIGHHIGH
,
182 (chip
->high_thres
>> 8) & 0xFF);
185 ret
= i2c_smbus_write_byte_data(chip
->client
,
186 TSL2563_CMD
| TSL2563_REG_LOWLOW
,
187 chip
->low_thres
& 0xFF);
190 ret
= i2c_smbus_write_byte_data(chip
->client
,
191 TSL2563_CMD
| TSL2563_REG_LOWHIGH
,
192 (chip
->low_thres
>> 8) & 0xFF);
193 /* Interrupt register is automatically written anyway if it is relevant
199 static void tsl2563_poweroff_work(struct work_struct
*work
)
201 struct tsl2563_chip
*chip
=
202 container_of(work
, struct tsl2563_chip
, poweroff_work
.work
);
203 tsl2563_set_power(chip
, 0);
206 static int tsl2563_detect(struct tsl2563_chip
*chip
)
210 ret
= tsl2563_set_power(chip
, 1);
214 ret
= tsl2563_get_power(chip
);
218 return ret
? 0 : -ENODEV
;
221 static int tsl2563_read_id(struct tsl2563_chip
*chip
, u8
*id
)
223 struct i2c_client
*client
= chip
->client
;
226 ret
= i2c_smbus_read_byte_data(client
, TSL2563_CMD
| TSL2563_REG_ID
);
236 * "Normalized" ADC value is one obtained with 400ms of integration time and
237 * 16x gain. This function returns the number of bits of shift needed to
238 * convert between normalized values and HW values obtained using given
239 * timing and gain settings.
241 static int adc_shiftbits(u8 timing
)
245 switch (timing
& TSL2563_TIMING_MASK
) {
246 case TSL2563_TIMING_13MS
:
249 case TSL2563_TIMING_100MS
:
252 case TSL2563_TIMING_400MS
:
257 if (!(timing
& TSL2563_TIMING_GAIN16
))
263 /* Convert a HW ADC value to normalized scale. */
264 static u32
normalize_adc(u16 adc
, u8 timing
)
266 return adc
<< adc_shiftbits(timing
);
269 static void tsl2563_wait_adc(struct tsl2563_chip
*chip
)
273 switch (chip
->gainlevel
->gaintime
& TSL2563_TIMING_MASK
) {
274 case TSL2563_TIMING_13MS
:
277 case TSL2563_TIMING_100MS
:
284 * TODO: Make sure that we wait at least required delay but why we
285 * have to extend it one tick more?
287 schedule_timeout_interruptible(msecs_to_jiffies(delay
) + 2);
290 static int tsl2563_adjust_gainlevel(struct tsl2563_chip
*chip
, u16 adc
)
292 struct i2c_client
*client
= chip
->client
;
294 if (adc
> chip
->gainlevel
->max
|| adc
< chip
->gainlevel
->min
) {
296 (adc
> chip
->gainlevel
->max
) ?
297 chip
->gainlevel
++ : chip
->gainlevel
--;
299 i2c_smbus_write_byte_data(client
,
300 TSL2563_CMD
| TSL2563_REG_TIMING
,
301 chip
->gainlevel
->gaintime
);
303 tsl2563_wait_adc(chip
);
304 tsl2563_wait_adc(chip
);
311 static int tsl2563_get_adc(struct tsl2563_chip
*chip
)
313 struct i2c_client
*client
= chip
->client
;
318 if (chip
->state
.event
!= PM_EVENT_ON
)
321 if (!chip
->int_enabled
) {
322 cancel_delayed_work(&chip
->poweroff_work
);
324 if (!tsl2563_get_power(chip
)) {
325 ret
= tsl2563_set_power(chip
, 1);
328 ret
= tsl2563_configure(chip
);
331 tsl2563_wait_adc(chip
);
336 ret
= i2c_smbus_read_word_data(client
,
337 TSL2563_CMD
| TSL2563_REG_DATA0LOW
);
342 ret
= i2c_smbus_read_word_data(client
,
343 TSL2563_CMD
| TSL2563_REG_DATA1LOW
);
348 retry
= tsl2563_adjust_gainlevel(chip
, adc0
);
351 chip
->data0
= normalize_adc(adc0
, chip
->gainlevel
->gaintime
);
352 chip
->data1
= normalize_adc(adc1
, chip
->gainlevel
->gaintime
);
354 if (!chip
->int_enabled
)
355 schedule_delayed_work(&chip
->poweroff_work
, 5 * HZ
);
362 static inline int calib_to_sysfs(u32 calib
)
364 return (int) (((calib
* CALIB_BASE_SYSFS
) +
365 CALIB_FRAC_HALF
) >> CALIB_FRAC_BITS
);
368 static inline u32
calib_from_sysfs(int value
)
370 return (((u32
) value
) << CALIB_FRAC_BITS
) / CALIB_BASE_SYSFS
;
374 * Conversions between lux and ADC values.
376 * The basic formula is lux = c0 * adc0 - c1 * adc1, where c0 and c1 are
377 * appropriate constants. Different constants are needed for different
378 * kinds of light, determined by the ratio adc1/adc0 (basically the ratio
379 * of the intensities in infrared and visible wavelengths). lux_table below
380 * lists the upper threshold of the adc1/adc0 ratio and the corresponding
384 struct tsl2563_lux_coeff
{
385 unsigned long ch_ratio
;
386 unsigned long ch0_coeff
;
387 unsigned long ch1_coeff
;
390 static const struct tsl2563_lux_coeff lux_table
[] = {
392 .ch_ratio
= FRAC10K(1300),
393 .ch0_coeff
= FRAC10K(315),
394 .ch1_coeff
= FRAC10K(262),
396 .ch_ratio
= FRAC10K(2600),
397 .ch0_coeff
= FRAC10K(337),
398 .ch1_coeff
= FRAC10K(430),
400 .ch_ratio
= FRAC10K(3900),
401 .ch0_coeff
= FRAC10K(363),
402 .ch1_coeff
= FRAC10K(529),
404 .ch_ratio
= FRAC10K(5200),
405 .ch0_coeff
= FRAC10K(392),
406 .ch1_coeff
= FRAC10K(605),
408 .ch_ratio
= FRAC10K(6500),
409 .ch0_coeff
= FRAC10K(229),
410 .ch1_coeff
= FRAC10K(291),
412 .ch_ratio
= FRAC10K(8000),
413 .ch0_coeff
= FRAC10K(157),
414 .ch1_coeff
= FRAC10K(180),
416 .ch_ratio
= FRAC10K(13000),
417 .ch0_coeff
= FRAC10K(34),
418 .ch1_coeff
= FRAC10K(26),
420 .ch_ratio
= ULONG_MAX
,
427 * Convert normalized, scaled ADC values to lux.
429 static unsigned int adc_to_lux(u32 adc0
, u32 adc1
)
431 const struct tsl2563_lux_coeff
*lp
= lux_table
;
432 unsigned long ratio
, lux
, ch0
= adc0
, ch1
= adc1
;
434 ratio
= ch0
? ((ch1
<< ADC_FRAC_BITS
) / ch0
) : ULONG_MAX
;
436 while (lp
->ch_ratio
< ratio
)
439 lux
= ch0
* lp
->ch0_coeff
- ch1
* lp
->ch1_coeff
;
441 return (unsigned int) (lux
>> ADC_FRAC_BITS
);
444 /*--------------------------------------------------------------*/
445 /* Sysfs interface */
446 /*--------------------------------------------------------------*/
449 /* Apply calibration coefficient to ADC count. */
450 static u32
calib_adc(u32 adc
, u32 calib
)
452 unsigned long scaled
= adc
;
455 scaled
>>= CALIB_FRAC_BITS
;
460 static int tsl2563_write_raw(struct iio_dev
*indio_dev
,
461 struct iio_chan_spec
const *chan
,
466 struct tsl2563_chip
*chip
= iio_priv(indio_dev
);
468 if (chan
->channel
== 0)
469 chip
->calib0
= calib_from_sysfs(val
);
471 chip
->calib1
= calib_from_sysfs(val
);
476 static int tsl2563_read_raw(struct iio_dev
*indio_dev
,
477 struct iio_chan_spec
const *chan
,
484 struct tsl2563_chip
*chip
= iio_priv(indio_dev
);
486 mutex_lock(&chip
->lock
);
489 switch (chan
->type
) {
491 ret
= tsl2563_get_adc(chip
);
494 calib0
= calib_adc(chip
->data0
, chip
->calib0
) *
495 chip
->cover_comp_gain
;
496 calib1
= calib_adc(chip
->data1
, chip
->calib1
) *
497 chip
->cover_comp_gain
;
498 *val
= adc_to_lux(calib0
, calib1
);
502 ret
= tsl2563_get_adc(chip
);
505 if (chan
->channel
== 0)
516 case IIO_CHAN_INFO_CALIBSCALE
:
517 if (chan
->channel
== 0)
518 *val
= calib_to_sysfs(chip
->calib0
);
520 *val
= calib_to_sysfs(chip
->calib1
);
529 mutex_unlock(&chip
->lock
);
533 static const struct iio_chan_spec tsl2563_channels
[] = {
539 .type
= IIO_INTENSITY
,
541 .channel2
= IIO_MOD_LIGHT_BOTH
,
542 .info_mask
= IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT
,
543 .event_mask
= (IIO_EV_BIT(IIO_EV_TYPE_THRESH
,
545 IIO_EV_BIT(IIO_EV_TYPE_THRESH
,
546 IIO_EV_DIR_FALLING
)),
548 .type
= IIO_INTENSITY
,
550 .channel2
= IIO_MOD_LIGHT_IR
,
551 .info_mask
= IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT
,
555 static int tsl2563_read_thresh(struct iio_dev
*indio_dev
,
559 struct tsl2563_chip
*chip
= iio_priv(indio_dev
);
561 switch (IIO_EVENT_CODE_EXTRACT_DIR(event_code
)) {
562 case IIO_EV_DIR_RISING
:
563 *val
= chip
->high_thres
;
565 case IIO_EV_DIR_FALLING
:
566 *val
= chip
->low_thres
;
575 static int tsl2563_write_thresh(struct iio_dev
*indio_dev
,
579 struct tsl2563_chip
*chip
= iio_priv(indio_dev
);
583 if (IIO_EVENT_CODE_EXTRACT_DIR(event_code
) == IIO_EV_DIR_RISING
)
584 address
= TSL2563_REG_HIGHLOW
;
586 address
= TSL2563_REG_LOWLOW
;
587 mutex_lock(&chip
->lock
);
588 ret
= i2c_smbus_write_byte_data(chip
->client
, TSL2563_CMD
| address
,
592 ret
= i2c_smbus_write_byte_data(chip
->client
,
593 TSL2563_CMD
| (address
+ 1),
595 if (IIO_EVENT_CODE_EXTRACT_DIR(event_code
) == IIO_EV_DIR_RISING
)
596 chip
->high_thres
= val
;
598 chip
->low_thres
= val
;
601 mutex_unlock(&chip
->lock
);
606 static irqreturn_t
tsl2563_event_handler(int irq
, void *private)
608 struct iio_dev
*dev_info
= private;
609 struct tsl2563_chip
*chip
= iio_priv(dev_info
);
611 iio_push_event(dev_info
,
612 IIO_UNMOD_EVENT_CODE(IIO_LIGHT
,
618 /* clear the interrupt and push the event */
619 i2c_smbus_write_byte(chip
->client
, TSL2563_CMD
| TSL2563_CLEARINT
);
623 static int tsl2563_write_interrupt_config(struct iio_dev
*indio_dev
,
627 struct tsl2563_chip
*chip
= iio_priv(indio_dev
);
630 mutex_lock(&chip
->lock
);
631 if (state
&& !(chip
->intr
& 0x30)) {
634 /* ensure the chip is actually on */
635 cancel_delayed_work(&chip
->poweroff_work
);
636 if (!tsl2563_get_power(chip
)) {
637 ret
= tsl2563_set_power(chip
, 1);
640 ret
= tsl2563_configure(chip
);
644 ret
= i2c_smbus_write_byte_data(chip
->client
,
645 TSL2563_CMD
| TSL2563_REG_INT
,
647 chip
->int_enabled
= true;
650 if (!state
&& (chip
->intr
& 0x30)) {
652 ret
= i2c_smbus_write_byte_data(chip
->client
,
653 TSL2563_CMD
| TSL2563_REG_INT
,
655 chip
->int_enabled
= false;
656 /* now the interrupt is not enabled, we can go to sleep */
657 schedule_delayed_work(&chip
->poweroff_work
, 5 * HZ
);
660 mutex_unlock(&chip
->lock
);
665 static int tsl2563_read_interrupt_config(struct iio_dev
*indio_dev
,
668 struct tsl2563_chip
*chip
= iio_priv(indio_dev
);
671 mutex_lock(&chip
->lock
);
672 ret
= i2c_smbus_read_byte_data(chip
->client
,
673 TSL2563_CMD
| TSL2563_REG_INT
);
674 mutex_unlock(&chip
->lock
);
677 ret
= !!(ret
& 0x30);
683 /*--------------------------------------------------------------*/
684 /* Probe, Attach, Remove */
685 /*--------------------------------------------------------------*/
686 static struct i2c_driver tsl2563_i2c_driver
;
688 static const struct iio_info tsl2563_info_no_irq
= {
689 .driver_module
= THIS_MODULE
,
690 .read_raw
= &tsl2563_read_raw
,
691 .write_raw
= &tsl2563_write_raw
,
694 static const struct iio_info tsl2563_info
= {
695 .driver_module
= THIS_MODULE
,
696 .read_raw
= &tsl2563_read_raw
,
697 .write_raw
= &tsl2563_write_raw
,
698 .read_event_value
= &tsl2563_read_thresh
,
699 .write_event_value
= &tsl2563_write_thresh
,
700 .read_event_config
= &tsl2563_read_interrupt_config
,
701 .write_event_config
= &tsl2563_write_interrupt_config
,
704 static int __devinit
tsl2563_probe(struct i2c_client
*client
,
705 const struct i2c_device_id
*device_id
)
707 struct iio_dev
*indio_dev
;
708 struct tsl2563_chip
*chip
;
709 struct tsl2563_platform_data
*pdata
= client
->dev
.platform_data
;
714 indio_dev
= iio_allocate_device(sizeof(*chip
));
718 chip
= iio_priv(indio_dev
);
720 i2c_set_clientdata(client
, chip
);
721 chip
->client
= client
;
723 err
= tsl2563_detect(chip
);
725 dev_err(&client
->dev
, "device not found, error %d\n", -err
);
729 err
= tsl2563_read_id(chip
, &id
);
733 mutex_init(&chip
->lock
);
735 /* Default values used until userspace says otherwise */
736 chip
->low_thres
= 0x0;
737 chip
->high_thres
= 0xffff;
738 chip
->gainlevel
= tsl2563_gainlevel_table
;
739 chip
->intr
= TSL2563_INT_PERSIST(4);
740 chip
->calib0
= calib_from_sysfs(CALIB_BASE_SYSFS
);
741 chip
->calib1
= calib_from_sysfs(CALIB_BASE_SYSFS
);
744 chip
->cover_comp_gain
= pdata
->cover_comp_gain
;
746 chip
->cover_comp_gain
= 1;
748 dev_info(&client
->dev
, "model %d, rev. %d\n", id
>> 4, id
& 0x0f);
749 indio_dev
->name
= client
->name
;
750 indio_dev
->channels
= tsl2563_channels
;
751 indio_dev
->num_channels
= ARRAY_SIZE(tsl2563_channels
);
752 indio_dev
->dev
.parent
= &client
->dev
;
753 indio_dev
->modes
= INDIO_DIRECT_MODE
;
755 indio_dev
->info
= &tsl2563_info
;
757 indio_dev
->info
= &tsl2563_info_no_irq
;
759 ret
= request_threaded_irq(client
->irq
,
761 &tsl2563_event_handler
,
762 IRQF_TRIGGER_RISING
| IRQF_ONESHOT
,
768 err
= tsl2563_configure(chip
);
772 INIT_DELAYED_WORK(&chip
->poweroff_work
, tsl2563_poweroff_work
);
773 /* The interrupt cannot yet be enabled so this is fine without lock */
774 schedule_delayed_work(&chip
->poweroff_work
, 5 * HZ
);
776 ret
= iio_device_register(indio_dev
);
783 free_irq(client
->irq
, indio_dev
);
785 iio_free_device(indio_dev
);
791 static int tsl2563_remove(struct i2c_client
*client
)
793 struct tsl2563_chip
*chip
= i2c_get_clientdata(client
);
794 struct iio_dev
*indio_dev
= iio_priv_to_dev(chip
);
796 iio_device_unregister(indio_dev
);
797 if (!chip
->int_enabled
)
798 cancel_delayed_work(&chip
->poweroff_work
);
799 /* Ensure that interrupts are disabled - then flush any bottom halves */
801 i2c_smbus_write_byte_data(chip
->client
, TSL2563_CMD
| TSL2563_REG_INT
,
803 flush_scheduled_work();
804 tsl2563_set_power(chip
, 0);
806 free_irq(client
->irq
, indio_dev
);
808 iio_free_device(indio_dev
);
813 static int tsl2563_suspend(struct i2c_client
*client
, pm_message_t state
)
815 struct tsl2563_chip
*chip
= i2c_get_clientdata(client
);
818 mutex_lock(&chip
->lock
);
820 ret
= tsl2563_set_power(chip
, 0);
827 mutex_unlock(&chip
->lock
);
831 static int tsl2563_resume(struct i2c_client
*client
)
833 struct tsl2563_chip
*chip
= i2c_get_clientdata(client
);
836 mutex_lock(&chip
->lock
);
838 ret
= tsl2563_set_power(chip
, 1);
842 ret
= tsl2563_configure(chip
);
846 chip
->state
.event
= PM_EVENT_ON
;
849 mutex_unlock(&chip
->lock
);
853 static const struct i2c_device_id tsl2563_id
[] = {
860 MODULE_DEVICE_TABLE(i2c
, tsl2563_id
);
862 static struct i2c_driver tsl2563_i2c_driver
= {
866 .suspend
= tsl2563_suspend
,
867 .resume
= tsl2563_resume
,
868 .probe
= tsl2563_probe
,
869 .remove
= __devexit_p(tsl2563_remove
),
870 .id_table
= tsl2563_id
,
872 module_i2c_driver(tsl2563_i2c_driver
);
874 MODULE_AUTHOR("Nokia Corporation");
875 MODULE_DESCRIPTION("tsl2563 light sensor driver");
876 MODULE_LICENSE("GPL");