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/sched.h>
31 #include <linux/mutex.h>
32 #include <linux/delay.h>
33 #include <linux/platform_device.h>
35 #include <linux/hwmon.h>
36 #include <linux/err.h>
41 #define DRIVER_NAME "tsl2563"
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 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 iio_dev
*indio_dev
;
119 struct delayed_work poweroff_work
;
121 /* Remember state for suspend and resume functions */
124 struct tsl2563_gainlevel_coeff
*gainlevel
;
126 /* Thresholds are in lux */
131 /* Calibration coefficients */
136 /* Cache current values, to be returned while suspended */
141 static int tsl2563_write(struct i2c_client
*client
, u8 reg
, u8 value
)
146 buf
[0] = TSL2563_CMD
| reg
;
149 ret
= i2c_master_send(client
, buf
, sizeof(buf
));
150 return (ret
== sizeof(buf
)) ? 0 : ret
;
153 static int tsl2563_read(struct i2c_client
*client
, u8 reg
, void *buf
, int len
)
156 u8 cmd
= TSL2563_CMD
| reg
;
158 ret
= i2c_master_send(client
, &cmd
, sizeof(cmd
));
159 if (ret
!= sizeof(cmd
))
162 return i2c_master_recv(client
, buf
, len
);
165 static int tsl2563_set_power(struct tsl2563_chip
*chip
, int on
)
167 struct i2c_client
*client
= chip
->client
;
170 cmd
= on
? TSL2563_CMD_POWER_ON
: TSL2563_CMD_POWER_OFF
;
171 return tsl2563_write(client
, TSL2563_REG_CTRL
, cmd
);
175 * Return value is 0 for off, 1 for on, or a negative error
176 * code if reading failed.
178 static int tsl2563_get_power(struct tsl2563_chip
*chip
)
180 struct i2c_client
*client
= chip
->client
;
184 ret
= tsl2563_read(client
, TSL2563_REG_CTRL
, &val
, sizeof(val
));
185 if (ret
!= sizeof(val
))
188 return (val
& TSL2563_CTRL_POWER_MASK
) == TSL2563_CMD_POWER_ON
;
191 static int tsl2563_configure(struct tsl2563_chip
*chip
)
193 struct i2c_client
*client
= chip
->client
;
196 ret
= tsl2563_write(client
, TSL2563_REG_TIMING
,
197 chip
->gainlevel
->gaintime
);
201 ret
= tsl2563_write(client
, TSL2563_REG_INT
, chip
->intr
);
207 static void tsl2563_poweroff_work(struct work_struct
*work
)
209 struct tsl2563_chip
*chip
=
210 container_of(work
, struct tsl2563_chip
, poweroff_work
.work
);
211 tsl2563_set_power(chip
, 0);
214 static int tsl2563_detect(struct tsl2563_chip
*chip
)
218 ret
= tsl2563_set_power(chip
, 1);
222 ret
= tsl2563_get_power(chip
);
226 return ret
? 0 : -ENODEV
;
229 static int tsl2563_read_id(struct tsl2563_chip
*chip
, u8
*id
)
231 struct i2c_client
*client
= chip
->client
;
234 ret
= tsl2563_read(client
, TSL2563_REG_ID
, id
, sizeof(*id
));
235 if (ret
!= sizeof(*id
))
242 * "Normalized" ADC value is one obtained with 400ms of integration time and
243 * 16x gain. This function returns the number of bits of shift needed to
244 * convert between normalized values and HW values obtained using given
245 * timing and gain settings.
247 static int adc_shiftbits(u8 timing
)
251 switch (timing
& TSL2563_TIMING_MASK
) {
252 case TSL2563_TIMING_13MS
:
255 case TSL2563_TIMING_100MS
:
258 case TSL2563_TIMING_400MS
:
263 if (!(timing
& TSL2563_TIMING_GAIN16
))
269 /* Convert a HW ADC value to normalized scale. */
270 static u32
normalize_adc(u16 adc
, u8 timing
)
272 return adc
<< adc_shiftbits(timing
);
275 static void tsl2563_wait_adc(struct tsl2563_chip
*chip
)
279 switch (chip
->gainlevel
->gaintime
& TSL2563_TIMING_MASK
) {
280 case TSL2563_TIMING_13MS
:
283 case TSL2563_TIMING_100MS
:
290 * TODO: Make sure that we wait at least required delay but why we
291 * have to extend it one tick more?
293 schedule_timeout_interruptible(msecs_to_jiffies(delay
) + 2);
296 static int tsl2563_adjust_gainlevel(struct tsl2563_chip
*chip
, u16 adc
)
298 struct i2c_client
*client
= chip
->client
;
300 if (adc
> chip
->gainlevel
->max
|| adc
< chip
->gainlevel
->min
) {
302 (adc
> chip
->gainlevel
->max
) ?
303 chip
->gainlevel
++ : chip
->gainlevel
--;
305 tsl2563_write(client
, TSL2563_REG_TIMING
,
306 chip
->gainlevel
->gaintime
);
308 tsl2563_wait_adc(chip
);
309 tsl2563_wait_adc(chip
);
316 static int tsl2563_get_adc(struct tsl2563_chip
*chip
)
318 struct i2c_client
*client
= chip
->client
;
324 if (chip
->state
.event
!= PM_EVENT_ON
)
327 cancel_delayed_work(&chip
->poweroff_work
);
329 if (!tsl2563_get_power(chip
)) {
330 ret
= tsl2563_set_power(chip
, 1);
333 ret
= tsl2563_configure(chip
);
336 tsl2563_wait_adc(chip
);
340 ret
= tsl2563_read(client
,
341 TSL2563_REG_DATA0LOW
| TSL2563_CLEARINT
,
343 if (ret
!= sizeof(buf0
))
346 ret
= tsl2563_read(client
, TSL2563_REG_DATA1LOW
,
348 if (ret
!= sizeof(buf1
))
351 adc0
= (buf0
[1] << 8) + buf0
[0];
352 adc1
= (buf1
[1] << 8) + buf1
[0];
354 retry
= tsl2563_adjust_gainlevel(chip
, adc0
);
357 chip
->data0
= normalize_adc(adc0
, chip
->gainlevel
->gaintime
);
358 chip
->data1
= normalize_adc(adc1
, chip
->gainlevel
->gaintime
);
360 schedule_delayed_work(&chip
->poweroff_work
, 5 * HZ
);
367 static inline int calib_to_sysfs(u32 calib
)
369 return (int) (((calib
* CALIB_BASE_SYSFS
) +
370 CALIB_FRAC_HALF
) >> CALIB_FRAC_BITS
);
373 static inline u32
calib_from_sysfs(int value
)
375 return (((u32
) value
) << CALIB_FRAC_BITS
) / CALIB_BASE_SYSFS
;
379 * Conversions between lux and ADC values.
381 * The basic formula is lux = c0 * adc0 - c1 * adc1, where c0 and c1 are
382 * appropriate constants. Different constants are needed for different
383 * kinds of light, determined by the ratio adc1/adc0 (basically the ratio
384 * of the intensities in infrared and visible wavelengths). lux_table below
385 * lists the upper threshold of the adc1/adc0 ratio and the corresponding
389 struct tsl2563_lux_coeff
{
390 unsigned long ch_ratio
;
391 unsigned long ch0_coeff
;
392 unsigned long ch1_coeff
;
395 static const struct tsl2563_lux_coeff lux_table
[] = {
397 .ch_ratio
= FRAC10K(1300),
398 .ch0_coeff
= FRAC10K(315),
399 .ch1_coeff
= FRAC10K(262),
401 .ch_ratio
= FRAC10K(2600),
402 .ch0_coeff
= FRAC10K(337),
403 .ch1_coeff
= FRAC10K(430),
405 .ch_ratio
= FRAC10K(3900),
406 .ch0_coeff
= FRAC10K(363),
407 .ch1_coeff
= FRAC10K(529),
409 .ch_ratio
= FRAC10K(5200),
410 .ch0_coeff
= FRAC10K(392),
411 .ch1_coeff
= FRAC10K(605),
413 .ch_ratio
= FRAC10K(6500),
414 .ch0_coeff
= FRAC10K(229),
415 .ch1_coeff
= FRAC10K(291),
417 .ch_ratio
= FRAC10K(8000),
418 .ch0_coeff
= FRAC10K(157),
419 .ch1_coeff
= FRAC10K(180),
421 .ch_ratio
= FRAC10K(13000),
422 .ch0_coeff
= FRAC10K(34),
423 .ch1_coeff
= FRAC10K(26),
425 .ch_ratio
= ULONG_MAX
,
432 * Convert normalized, scaled ADC values to lux.
434 static unsigned int adc_to_lux(u32 adc0
, u32 adc1
)
436 const struct tsl2563_lux_coeff
*lp
= lux_table
;
437 unsigned long ratio
, lux
, ch0
= adc0
, ch1
= adc1
;
439 ratio
= ch0
? ((ch1
<< ADC_FRAC_BITS
) / ch0
) : ULONG_MAX
;
441 while (lp
->ch_ratio
< ratio
)
444 lux
= ch0
* lp
->ch0_coeff
- ch1
* lp
->ch1_coeff
;
446 return (unsigned int) (lux
>> ADC_FRAC_BITS
);
449 /*--------------------------------------------------------------*/
450 /* Sysfs interface */
451 /*--------------------------------------------------------------*/
453 static ssize_t
tsl2563_adc0_show(struct device
*dev
,
454 struct device_attribute
*attr
, char *buf
)
456 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
457 struct tsl2563_chip
*chip
= indio_dev
->dev_data
;
460 mutex_lock(&chip
->lock
);
462 ret
= tsl2563_get_adc(chip
);
466 ret
= snprintf(buf
, PAGE_SIZE
, "%d\n", chip
->data0
);
468 mutex_unlock(&chip
->lock
);
472 static ssize_t
tsl2563_adc1_show(struct device
*dev
,
473 struct device_attribute
*attr
, char *buf
)
475 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
476 struct tsl2563_chip
*chip
= indio_dev
->dev_data
;
479 mutex_lock(&chip
->lock
);
481 ret
= tsl2563_get_adc(chip
);
485 ret
= snprintf(buf
, PAGE_SIZE
, "%d\n", chip
->data1
);
487 mutex_unlock(&chip
->lock
);
491 /* Apply calibration coefficient to ADC count. */
492 static u32
calib_adc(u32 adc
, u32 calib
)
494 unsigned long scaled
= adc
;
497 scaled
>>= CALIB_FRAC_BITS
;
502 static ssize_t
tsl2563_lux_show(struct device
*dev
,
503 struct device_attribute
*attr
, char *buf
)
505 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
506 struct tsl2563_chip
*chip
= indio_dev
->dev_data
;
510 mutex_lock(&chip
->lock
);
512 ret
= tsl2563_get_adc(chip
);
516 calib0
= calib_adc(chip
->data0
, chip
->calib0
) * chip
->cover_comp_gain
;
517 calib1
= calib_adc(chip
->data1
, chip
->calib1
) * chip
->cover_comp_gain
;
519 ret
= snprintf(buf
, PAGE_SIZE
, "%d\n", adc_to_lux(calib0
, calib1
));
522 mutex_unlock(&chip
->lock
);
526 static ssize_t
format_calib(char *buf
, int len
, u32 calib
)
528 return snprintf(buf
, PAGE_SIZE
, "%d\n", calib_to_sysfs(calib
));
531 static ssize_t
tsl2563_calib0_show(struct device
*dev
,
532 struct device_attribute
*attr
, char *buf
)
534 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
535 struct tsl2563_chip
*chip
= indio_dev
->dev_data
;
538 mutex_lock(&chip
->lock
);
539 ret
= format_calib(buf
, PAGE_SIZE
, chip
->calib0
);
540 mutex_unlock(&chip
->lock
);
544 static ssize_t
tsl2563_calib1_show(struct device
*dev
,
545 struct device_attribute
*attr
, char *buf
)
547 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
548 struct tsl2563_chip
*chip
= indio_dev
->dev_data
;
551 mutex_lock(&chip
->lock
);
552 ret
= format_calib(buf
, PAGE_SIZE
, chip
->calib1
);
553 mutex_unlock(&chip
->lock
);
557 static int do_calib_store(struct device
*dev
, const char *buf
, size_t len
,
560 struct iio_dev
*indio_dev
= dev_get_drvdata(dev
);
561 struct tsl2563_chip
*chip
= indio_dev
->dev_data
;
565 if (1 != sscanf(buf
, "%d", &value
))
568 calib
= calib_from_sysfs(value
);
571 chip
->calib1
= calib
;
573 chip
->calib0
= calib
;
578 static ssize_t
tsl2563_calib0_store(struct device
*dev
,
579 struct device_attribute
*attr
,
580 const char *buf
, size_t len
)
582 return do_calib_store(dev
, buf
, len
, 0);
585 static ssize_t
tsl2563_calib1_store(struct device
*dev
,
586 struct device_attribute
*attr
,
587 const char *buf
, size_t len
)
589 return do_calib_store(dev
, buf
, len
, 1);
592 /* AmitXXXX: Convert to IIO_DEV_ATTR_LIGHT* as in tsl2561
593 * once I understand what they mean */
594 static DEVICE_ATTR(adc0
, S_IRUGO
, tsl2563_adc0_show
, NULL
);
595 static DEVICE_ATTR(adc1
, S_IRUGO
, tsl2563_adc1_show
, NULL
);
596 static DEVICE_ATTR(lux
, S_IRUGO
, tsl2563_lux_show
, NULL
);
597 static DEVICE_ATTR(calib0
, S_IRUGO
| S_IWUSR
,
598 tsl2563_calib0_show
, tsl2563_calib0_store
);
599 static DEVICE_ATTR(calib1
, S_IRUGO
| S_IWUSR
,
600 tsl2563_calib1_show
, tsl2563_calib1_store
);
602 static struct attribute
*tsl2563_attributes
[] = {
606 &dev_attr_calib0
.attr
,
607 &dev_attr_calib1
.attr
,
611 static const struct attribute_group tsl2563_group
= {
612 .attrs
= tsl2563_attributes
,
615 /*--------------------------------------------------------------*/
616 /* Probe, Attach, Remove */
617 /*--------------------------------------------------------------*/
618 static struct i2c_driver tsl2563_i2c_driver
;
620 static int __devinit
tsl2563_probe(struct i2c_client
*client
,
621 const struct i2c_device_id
*device_id
)
623 struct tsl2563_chip
*chip
;
624 struct tsl2563_platform_data
*pdata
= client
->dev
.platform_data
;
629 chip
= kzalloc(sizeof(*chip
), GFP_KERNEL
);
633 i2c_set_clientdata(client
, chip
);
634 chip
->client
= client
;
636 err
= tsl2563_detect(chip
);
638 dev_err(&client
->dev
, "device not found, error %d \n", -err
);
642 err
= tsl2563_read_id(chip
, &id
);
646 mutex_init(&chip
->lock
);
648 /* Default values used until userspace says otherwise */
649 chip
->low_thres
= 0x0;
650 chip
->high_thres
= 0xffff;
651 chip
->gainlevel
= tsl2563_gainlevel_table
;
652 chip
->intr
= TSL2563_INT_PERSIST(4);
653 chip
->calib0
= calib_from_sysfs(CALIB_BASE_SYSFS
);
654 chip
->calib1
= calib_from_sysfs(CALIB_BASE_SYSFS
);
657 chip
->cover_comp_gain
= pdata
->cover_comp_gain
;
659 chip
->cover_comp_gain
= 1;
661 dev_info(&client
->dev
, "model %d, rev. %d\n", id
>> 4, id
& 0x0f);
663 chip
->indio_dev
= iio_allocate_device();
664 if (!chip
->indio_dev
)
666 chip
->indio_dev
->attrs
= &tsl2563_group
;
667 chip
->indio_dev
->dev
.parent
= &client
->dev
;
668 chip
->indio_dev
->dev_data
= (void *)(chip
);
669 chip
->indio_dev
->driver_module
= THIS_MODULE
;
670 chip
->indio_dev
->modes
= INDIO_DIRECT_MODE
;
671 ret
= iio_device_register(chip
->indio_dev
);
675 err
= tsl2563_configure(chip
);
679 INIT_DELAYED_WORK(&chip
->poweroff_work
, tsl2563_poweroff_work
);
680 schedule_delayed_work(&chip
->poweroff_work
, 5 * HZ
);
684 iio_device_unregister(chip
->indio_dev
);
690 static int tsl2563_remove(struct i2c_client
*client
)
692 struct tsl2563_chip
*chip
= i2c_get_clientdata(client
);
694 iio_device_unregister(chip
->indio_dev
);
700 static int tsl2563_suspend(struct i2c_client
*client
, pm_message_t state
)
702 struct tsl2563_chip
*chip
= i2c_get_clientdata(client
);
705 mutex_lock(&chip
->lock
);
707 ret
= tsl2563_set_power(chip
, 0);
714 mutex_unlock(&chip
->lock
);
718 static int tsl2563_resume(struct i2c_client
*client
)
720 struct tsl2563_chip
*chip
= i2c_get_clientdata(client
);
723 mutex_lock(&chip
->lock
);
725 ret
= tsl2563_set_power(chip
, 1);
729 ret
= tsl2563_configure(chip
);
733 chip
->state
.event
= PM_EVENT_ON
;
736 mutex_unlock(&chip
->lock
);
740 static const struct i2c_device_id tsl2563_id
[] = {
744 MODULE_DEVICE_TABLE(i2c
, tsl2563_id
);
746 static struct i2c_driver tsl2563_i2c_driver
= {
750 .suspend
= tsl2563_suspend
,
751 .resume
= tsl2563_resume
,
752 .probe
= tsl2563_probe
,
753 .remove
= __devexit_p(tsl2563_remove
),
754 .id_table
= tsl2563_id
,
757 static int __init
tsl2563_init(void)
759 return i2c_add_driver(&tsl2563_i2c_driver
);
762 static void __exit
tsl2563_exit(void)
764 i2c_del_driver(&tsl2563_i2c_driver
);
767 MODULE_AUTHOR("Nokia Corporation");
768 MODULE_DESCRIPTION("tsl2563 light sensor driver");
769 MODULE_LICENSE("GPL");
771 module_init(tsl2563_init
);
772 module_exit(tsl2563_exit
);