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>
42
/* Use this many bits for fraction part. */
43
#define ADC_FRAC_BITS (14)
45
/* Given number of 1/10000's in ADC_FRAC_BITS precision. */
46
#define FRAC10K(f) (((f) * (1L << (ADC_FRAC_BITS))) / (10000))
48
/* Bits used for fraction in calibration coefficients.*/
49
#define CALIB_FRAC_BITS (10)
50
/* 0.5 in CALIB_FRAC_BITS precision */
51
#define CALIB_FRAC_HALF (1 << (CALIB_FRAC_BITS - 1))
52
/* Make a fraction from a number n that was multiplied with b. */
53
#define CALIB_FRAC(n, b) (((n) << CALIB_FRAC_BITS) / (b))
54
/* Decimal 10^(digits in sysfs presentation) */
55
#define CALIB_BASE_SYSFS (1000)
57
#define TSL2563_CMD (0x80)
58
#define TSL2563_CLEARINT (0x40)
60
#define TSL2563_REG_CTRL (0x00)
61
#define TSL2563_REG_TIMING (0x01)
62
#define TSL2563_REG_LOWLOW (0x02) /* data0 low threshold, 2 bytes */
63
#define TSL2563_REG_LOWHIGH (0x03)
64
#define TSL2563_REG_HIGHLOW (0x04) /* data0 high threshold, 2 bytes */
65
#define TSL2563_REG_HIGHHIGH (0x05)
66
#define TSL2563_REG_INT (0x06)
67
#define TSL2563_REG_ID (0x0a)
68
#define TSL2563_REG_DATA0LOW (0x0c) /* broadband sensor value, 2 bytes */
69
#define TSL2563_REG_DATA0HIGH (0x0d)
70
#define TSL2563_REG_DATA1LOW (0x0e) /* infrared sensor value, 2 bytes */
71
#define TSL2563_REG_DATA1HIGH (0x0f)
73
#define TSL2563_CMD_POWER_ON (0x03)
74
#define TSL2563_CMD_POWER_OFF (0x00)
75
#define TSL2563_CTRL_POWER_MASK (0x03)
77
#define TSL2563_TIMING_13MS (0x00)
78
#define TSL2563_TIMING_100MS (0x01)
79
#define TSL2563_TIMING_400MS (0x02)
80
#define TSL2563_TIMING_MASK (0x03)
81
#define TSL2563_TIMING_GAIN16 (0x10)
82
#define TSL2563_TIMING_GAIN1 (0x00)
84
#define TSL2563_INT_DISBLED (0x00)
85
#define TSL2563_INT_LEVEL (0x10)
86
#define TSL2563_INT_PERSIST(n) ((n) & 0x0F)
88
struct tsl2563_gainlevel_coeff {
94
static const struct tsl2563_gainlevel_coeff tsl2563_gainlevel_table[] = {
96
.gaintime = TSL2563_TIMING_400MS | TSL2563_TIMING_GAIN16,
100
.gaintime = TSL2563_TIMING_400MS | TSL2563_TIMING_GAIN1,
104
.gaintime = TSL2563_TIMING_100MS | TSL2563_TIMING_GAIN1,
108
.gaintime = TSL2563_TIMING_13MS | TSL2563_TIMING_GAIN1,
114
struct tsl2563_chip {
116
struct i2c_client *client;
117
struct delayed_work poweroff_work;
119
/* Remember state for suspend and resume functions */
122
struct tsl2563_gainlevel_coeff const *gainlevel;
129
/* Calibration coefficients */
134
/* Cache current values, to be returned while suspended */
139
static int tsl2563_set_power(struct tsl2563_chip *chip, int on)
141
struct i2c_client *client = chip->client;
144
cmd = on ? TSL2563_CMD_POWER_ON : TSL2563_CMD_POWER_OFF;
145
return i2c_smbus_write_byte_data(client,
146
TSL2563_CMD | TSL2563_REG_CTRL, cmd);
150
* Return value is 0 for off, 1 for on, or a negative error
151
* code if reading failed.
153
static int tsl2563_get_power(struct tsl2563_chip *chip)
155
struct i2c_client *client = chip->client;
158
ret = i2c_smbus_read_byte_data(client, TSL2563_CMD | TSL2563_REG_CTRL);
162
return (ret & TSL2563_CTRL_POWER_MASK) == TSL2563_CMD_POWER_ON;
165
static int tsl2563_configure(struct tsl2563_chip *chip)
169
ret = i2c_smbus_write_byte_data(chip->client,
170
TSL2563_CMD | TSL2563_REG_TIMING,
171
chip->gainlevel->gaintime);
174
ret = i2c_smbus_write_byte_data(chip->client,
175
TSL2563_CMD | TSL2563_REG_HIGHLOW,
176
chip->high_thres & 0xFF);
179
ret = i2c_smbus_write_byte_data(chip->client,
180
TSL2563_CMD | TSL2563_REG_HIGHHIGH,
181
(chip->high_thres >> 8) & 0xFF);
184
ret = i2c_smbus_write_byte_data(chip->client,
185
TSL2563_CMD | TSL2563_REG_LOWLOW,
186
chip->low_thres & 0xFF);
189
ret = i2c_smbus_write_byte_data(chip->client,
190
TSL2563_CMD | TSL2563_REG_LOWHIGH,
191
(chip->low_thres >> 8) & 0xFF);
192
/* Interrupt register is automatically written anyway if it is relevant
198
static void tsl2563_poweroff_work(struct work_struct *work)
200
struct tsl2563_chip *chip =
201
container_of(work, struct tsl2563_chip, poweroff_work.work);
202
tsl2563_set_power(chip, 0);
205
static int tsl2563_detect(struct tsl2563_chip *chip)
209
ret = tsl2563_set_power(chip, 1);
213
ret = tsl2563_get_power(chip);
217
return ret ? 0 : -ENODEV;
220
static int tsl2563_read_id(struct tsl2563_chip *chip, u8 *id)
222
struct i2c_client *client = chip->client;
225
ret = i2c_smbus_read_byte_data(client, TSL2563_CMD | TSL2563_REG_ID);
233
* "Normalized" ADC value is one obtained with 400ms of integration time and
234
* 16x gain. This function returns the number of bits of shift needed to
235
* convert between normalized values and HW values obtained using given
236
* timing and gain settings.
238
static int adc_shiftbits(u8 timing)
242
switch (timing & TSL2563_TIMING_MASK) {
243
case TSL2563_TIMING_13MS:
246
case TSL2563_TIMING_100MS:
249
case TSL2563_TIMING_400MS:
254
if (!(timing & TSL2563_TIMING_GAIN16))
260
/* Convert a HW ADC value to normalized scale. */
261
static u32 normalize_adc(u16 adc, u8 timing)
263
return adc << adc_shiftbits(timing);
266
static void tsl2563_wait_adc(struct tsl2563_chip *chip)
270
switch (chip->gainlevel->gaintime & TSL2563_TIMING_MASK) {
271
case TSL2563_TIMING_13MS:
274
case TSL2563_TIMING_100MS:
281
* TODO: Make sure that we wait at least required delay but why we
282
* have to extend it one tick more?
284
schedule_timeout_interruptible(msecs_to_jiffies(delay) + 2);
287
static int tsl2563_adjust_gainlevel(struct tsl2563_chip *chip, u16 adc)
289
struct i2c_client *client = chip->client;
291
if (adc > chip->gainlevel->max || adc < chip->gainlevel->min) {
293
(adc > chip->gainlevel->max) ?
294
chip->gainlevel++ : chip->gainlevel--;
296
i2c_smbus_write_byte_data(client,
297
TSL2563_CMD | TSL2563_REG_TIMING,
298
chip->gainlevel->gaintime);
300
tsl2563_wait_adc(chip);
301
tsl2563_wait_adc(chip);
308
static int tsl2563_get_adc(struct tsl2563_chip *chip)
310
struct i2c_client *client = chip->client;
315
if (chip->state.event != PM_EVENT_ON)
318
if (!chip->int_enabled) {
319
cancel_delayed_work(&chip->poweroff_work);
321
if (!tsl2563_get_power(chip)) {
322
ret = tsl2563_set_power(chip, 1);
325
ret = tsl2563_configure(chip);
328
tsl2563_wait_adc(chip);
333
ret = i2c_smbus_read_word_data(client,
334
TSL2563_CMD | TSL2563_REG_DATA0LOW);
339
ret = i2c_smbus_read_word_data(client,
340
TSL2563_CMD | TSL2563_REG_DATA1LOW);
345
retry = tsl2563_adjust_gainlevel(chip, adc0);
348
chip->data0 = normalize_adc(adc0, chip->gainlevel->gaintime);
349
chip->data1 = normalize_adc(adc1, chip->gainlevel->gaintime);
351
if (!chip->int_enabled)
352
schedule_delayed_work(&chip->poweroff_work, 5 * HZ);
359
static inline int calib_to_sysfs(u32 calib)
361
return (int) (((calib * CALIB_BASE_SYSFS) +
362
CALIB_FRAC_HALF) >> CALIB_FRAC_BITS);
365
static inline u32 calib_from_sysfs(int value)
367
return (((u32) value) << CALIB_FRAC_BITS) / CALIB_BASE_SYSFS;
371
* Conversions between lux and ADC values.
373
* The basic formula is lux = c0 * adc0 - c1 * adc1, where c0 and c1 are
374
* appropriate constants. Different constants are needed for different
375
* kinds of light, determined by the ratio adc1/adc0 (basically the ratio
376
* of the intensities in infrared and visible wavelengths). lux_table below
377
* lists the upper threshold of the adc1/adc0 ratio and the corresponding
381
struct tsl2563_lux_coeff {
382
unsigned long ch_ratio;
383
unsigned long ch0_coeff;
384
unsigned long ch1_coeff;
387
static const struct tsl2563_lux_coeff lux_table[] = {
389
.ch_ratio = FRAC10K(1300),
390
.ch0_coeff = FRAC10K(315),
391
.ch1_coeff = FRAC10K(262),
393
.ch_ratio = FRAC10K(2600),
394
.ch0_coeff = FRAC10K(337),
395
.ch1_coeff = FRAC10K(430),
397
.ch_ratio = FRAC10K(3900),
398
.ch0_coeff = FRAC10K(363),
399
.ch1_coeff = FRAC10K(529),
401
.ch_ratio = FRAC10K(5200),
402
.ch0_coeff = FRAC10K(392),
403
.ch1_coeff = FRAC10K(605),
405
.ch_ratio = FRAC10K(6500),
406
.ch0_coeff = FRAC10K(229),
407
.ch1_coeff = FRAC10K(291),
409
.ch_ratio = FRAC10K(8000),
410
.ch0_coeff = FRAC10K(157),
411
.ch1_coeff = FRAC10K(180),
413
.ch_ratio = FRAC10K(13000),
414
.ch0_coeff = FRAC10K(34),
415
.ch1_coeff = FRAC10K(26),
417
.ch_ratio = ULONG_MAX,
424
* Convert normalized, scaled ADC values to lux.
426
static unsigned int adc_to_lux(u32 adc0, u32 adc1)
428
const struct tsl2563_lux_coeff *lp = lux_table;
429
unsigned long ratio, lux, ch0 = adc0, ch1 = adc1;
431
ratio = ch0 ? ((ch1 << ADC_FRAC_BITS) / ch0) : ULONG_MAX;
433
while (lp->ch_ratio < ratio)
436
lux = ch0 * lp->ch0_coeff - ch1 * lp->ch1_coeff;
438
return (unsigned int) (lux >> ADC_FRAC_BITS);
441
/*--------------------------------------------------------------*/
442
/* Sysfs interface */
443
/*--------------------------------------------------------------*/
446
/* Apply calibration coefficient to ADC count. */
447
static u32 calib_adc(u32 adc, u32 calib)
449
unsigned long scaled = adc;
452
scaled >>= CALIB_FRAC_BITS;
457
static int tsl2563_write_raw(struct iio_dev *indio_dev,
458
struct iio_chan_spec const *chan,
463
struct tsl2563_chip *chip = iio_priv(indio_dev);
465
if (chan->channel == 0)
466
chip->calib0 = calib_from_sysfs(val);
468
chip->calib1 = calib_from_sysfs(val);
473
static int tsl2563_read_raw(struct iio_dev *indio_dev,
474
struct iio_chan_spec const *chan,
481
struct tsl2563_chip *chip = iio_priv(indio_dev);
483
mutex_lock(&chip->lock);
486
switch (chan->type) {
488
ret = tsl2563_get_adc(chip);
491
calib0 = calib_adc(chip->data0, chip->calib0) *
492
chip->cover_comp_gain;
493
calib1 = calib_adc(chip->data1, chip->calib1) *
494
chip->cover_comp_gain;
495
*val = adc_to_lux(calib0, calib1);
499
ret = tsl2563_get_adc(chip);
502
if (chan->channel == 0)
513
case (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE):
514
if (chan->channel == 0)
515
*val = calib_to_sysfs(chip->calib0);
517
*val = calib_to_sysfs(chip->calib1);
526
mutex_unlock(&chip->lock);
530
static const struct iio_chan_spec tsl2563_channels[] = {
536
.type = IIO_INTENSITY,
538
.channel2 = IIO_MOD_LIGHT_BOTH,
539
.info_mask = (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE),
540
.event_mask = (IIO_EV_BIT(IIO_EV_TYPE_THRESH,
542
IIO_EV_BIT(IIO_EV_TYPE_THRESH,
543
IIO_EV_DIR_FALLING)),
545
.type = IIO_INTENSITY,
547
.channel2 = IIO_MOD_LIGHT_BOTH,
548
.info_mask = (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE),
552
static int tsl2563_read_thresh(struct iio_dev *indio_dev,
556
struct tsl2563_chip *chip = iio_priv(indio_dev);
558
switch (IIO_EVENT_CODE_EXTRACT_DIR(event_code)) {
559
case IIO_EV_DIR_RISING:
560
*val = chip->high_thres;
562
case IIO_EV_DIR_FALLING:
563
*val = chip->low_thres;
572
static int tsl2563_write_thresh(struct iio_dev *indio_dev,
576
struct tsl2563_chip *chip = iio_priv(indio_dev);
580
if (IIO_EVENT_CODE_EXTRACT_DIR(event_code) == IIO_EV_DIR_RISING)
581
address = TSL2563_REG_HIGHLOW;
583
address = TSL2563_REG_LOWLOW;
584
mutex_lock(&chip->lock);
585
ret = i2c_smbus_write_byte_data(chip->client, TSL2563_CMD | address,
589
ret = i2c_smbus_write_byte_data(chip->client,
590
TSL2563_CMD | (address + 1),
592
if (IIO_EVENT_CODE_EXTRACT_DIR(event_code) == IIO_EV_DIR_RISING)
593
chip->high_thres = val;
595
chip->low_thres = val;
598
mutex_unlock(&chip->lock);
603
static irqreturn_t tsl2563_event_handler(int irq, void *private)
605
struct iio_dev *dev_info = private;
606
struct tsl2563_chip *chip = iio_priv(dev_info);
608
iio_push_event(dev_info,
609
IIO_UNMOD_EVENT_CODE(IIO_LIGHT,
615
/* clear the interrupt and push the event */
616
i2c_smbus_write_byte(chip->client, TSL2563_CMD | TSL2563_CLEARINT);
620
static int tsl2563_write_interrupt_config(struct iio_dev *indio_dev,
624
struct tsl2563_chip *chip = iio_priv(indio_dev);
627
mutex_lock(&chip->lock);
628
if (state && !(chip->intr & 0x30)) {
631
/* ensure the chip is actually on */
632
cancel_delayed_work(&chip->poweroff_work);
633
if (!tsl2563_get_power(chip)) {
634
ret = tsl2563_set_power(chip, 1);
637
ret = tsl2563_configure(chip);
641
ret = i2c_smbus_write_byte_data(chip->client,
642
TSL2563_CMD | TSL2563_REG_INT,
644
chip->int_enabled = true;
647
if (!state && (chip->intr & 0x30)) {
649
ret = i2c_smbus_write_byte_data(chip->client,
650
TSL2563_CMD | TSL2563_REG_INT,
652
chip->int_enabled = false;
653
/* now the interrupt is not enabled, we can go to sleep */
654
schedule_delayed_work(&chip->poweroff_work, 5 * HZ);
657
mutex_unlock(&chip->lock);
662
static int tsl2563_read_interrupt_config(struct iio_dev *indio_dev,
665
struct tsl2563_chip *chip = iio_priv(indio_dev);
668
mutex_lock(&chip->lock);
669
ret = i2c_smbus_read_byte_data(chip->client,
670
TSL2563_CMD | TSL2563_REG_INT);
671
mutex_unlock(&chip->lock);
674
ret = !!(ret & 0x30);
680
/*--------------------------------------------------------------*/
681
/* Probe, Attach, Remove */
682
/*--------------------------------------------------------------*/
683
static struct i2c_driver tsl2563_i2c_driver;
685
static const struct iio_info tsl2563_info_no_irq = {
686
.driver_module = THIS_MODULE,
687
.read_raw = &tsl2563_read_raw,
688
.write_raw = &tsl2563_write_raw,
691
static const struct iio_info tsl2563_info = {
692
.driver_module = THIS_MODULE,
693
.read_raw = &tsl2563_read_raw,
694
.write_raw = &tsl2563_write_raw,
695
.read_event_value = &tsl2563_read_thresh,
696
.write_event_value = &tsl2563_write_thresh,
697
.read_event_config = &tsl2563_read_interrupt_config,
698
.write_event_config = &tsl2563_write_interrupt_config,
701
static int __devinit tsl2563_probe(struct i2c_client *client,
702
const struct i2c_device_id *device_id)
704
struct iio_dev *indio_dev;
705
struct tsl2563_chip *chip;
706
struct tsl2563_platform_data *pdata = client->dev.platform_data;
711
indio_dev = iio_allocate_device(sizeof(*chip));
715
chip = iio_priv(indio_dev);
717
i2c_set_clientdata(client, chip);
718
chip->client = client;
720
err = tsl2563_detect(chip);
722
dev_err(&client->dev, "device not found, error %d\n", -err);
726
err = tsl2563_read_id(chip, &id);
730
mutex_init(&chip->lock);
732
/* Default values used until userspace says otherwise */
733
chip->low_thres = 0x0;
734
chip->high_thres = 0xffff;
735
chip->gainlevel = tsl2563_gainlevel_table;
736
chip->intr = TSL2563_INT_PERSIST(4);
737
chip->calib0 = calib_from_sysfs(CALIB_BASE_SYSFS);
738
chip->calib1 = calib_from_sysfs(CALIB_BASE_SYSFS);
741
chip->cover_comp_gain = pdata->cover_comp_gain;
743
chip->cover_comp_gain = 1;
745
dev_info(&client->dev, "model %d, rev. %d\n", id >> 4, id & 0x0f);
746
indio_dev->name = client->name;
747
indio_dev->channels = tsl2563_channels;
748
indio_dev->num_channels = ARRAY_SIZE(tsl2563_channels);
749
indio_dev->dev.parent = &client->dev;
750
indio_dev->modes = INDIO_DIRECT_MODE;
752
indio_dev->info = &tsl2563_info;
754
indio_dev->info = &tsl2563_info_no_irq;
756
ret = request_threaded_irq(client->irq,
758
&tsl2563_event_handler,
759
IRQF_TRIGGER_RISING | IRQF_ONESHOT,
765
err = tsl2563_configure(chip);
769
INIT_DELAYED_WORK(&chip->poweroff_work, tsl2563_poweroff_work);
770
/* The interrupt cannot yet be enabled so this is fine without lock */
771
schedule_delayed_work(&chip->poweroff_work, 5 * HZ);
773
ret = iio_device_register(indio_dev);
780
free_irq(client->irq, indio_dev);
782
iio_free_device(indio_dev);
788
static int tsl2563_remove(struct i2c_client *client)
790
struct tsl2563_chip *chip = i2c_get_clientdata(client);
791
struct iio_dev *indio_dev = iio_priv_to_dev(chip);
793
iio_device_unregister(indio_dev);
794
if (!chip->int_enabled)
795
cancel_delayed_work(&chip->poweroff_work);
796
/* Ensure that interrupts are disabled - then flush any bottom halves */
798
i2c_smbus_write_byte_data(chip->client, TSL2563_CMD | TSL2563_REG_INT,
800
flush_scheduled_work();
801
tsl2563_set_power(chip, 0);
803
free_irq(client->irq, indio_dev);
805
iio_free_device(indio_dev);
810
static int tsl2563_suspend(struct i2c_client *client, pm_message_t state)
812
struct tsl2563_chip *chip = i2c_get_clientdata(client);
815
mutex_lock(&chip->lock);
817
ret = tsl2563_set_power(chip, 0);
824
mutex_unlock(&chip->lock);
828
static int tsl2563_resume(struct i2c_client *client)
830
struct tsl2563_chip *chip = i2c_get_clientdata(client);
833
mutex_lock(&chip->lock);
835
ret = tsl2563_set_power(chip, 1);
839
ret = tsl2563_configure(chip);
843
chip->state.event = PM_EVENT_ON;
846
mutex_unlock(&chip->lock);
850
static const struct i2c_device_id tsl2563_id[] = {
857
MODULE_DEVICE_TABLE(i2c, tsl2563_id);
859
static struct i2c_driver tsl2563_i2c_driver = {
863
.suspend = tsl2563_suspend,
864
.resume = tsl2563_resume,
865
.probe = tsl2563_probe,
866
.remove = __devexit_p(tsl2563_remove),
867
.id_table = tsl2563_id,
870
static int __init tsl2563_init(void)
872
return i2c_add_driver(&tsl2563_i2c_driver);
875
static void __exit tsl2563_exit(void)
877
i2c_del_driver(&tsl2563_i2c_driver);
880
MODULE_AUTHOR("Nokia Corporation");
881
MODULE_DESCRIPTION("tsl2563 light sensor driver");
882
MODULE_LICENSE("GPL");
884
module_init(tsl2563_init);
885
module_exit(tsl2563_exit);