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>
34 #include <linux/platform_device.h>
36 #include <linux/hwmon.h>
37 #include <linux/err.h>
38 #include <linux/slab.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);
234 * "Normalized" ADC value is one obtained with 400ms of integration time and
235 * 16x gain. This function returns the number of bits of shift needed to
236 * convert between normalized values and HW values obtained using given
237 * timing and gain settings.
239 static int adc_shiftbits(u8 timing)
243 switch (timing & TSL2563_TIMING_MASK) {
244 case TSL2563_TIMING_13MS:
247 case TSL2563_TIMING_100MS:
250 case TSL2563_TIMING_400MS:
255 if (!(timing & TSL2563_TIMING_GAIN16))
261 /* Convert a HW ADC value to normalized scale. */
262 static u32 normalize_adc(u16 adc, u8 timing)
264 return adc << adc_shiftbits(timing);
267 static void tsl2563_wait_adc(struct tsl2563_chip *chip)
271 switch (chip->gainlevel->gaintime & TSL2563_TIMING_MASK) {
272 case TSL2563_TIMING_13MS:
275 case TSL2563_TIMING_100MS:
282 * TODO: Make sure that we wait at least required delay but why we
283 * have to extend it one tick more?
285 schedule_timeout_interruptible(msecs_to_jiffies(delay) + 2);
288 static int tsl2563_adjust_gainlevel(struct tsl2563_chip *chip, u16 adc)
290 struct i2c_client *client = chip->client;
292 if (adc > chip->gainlevel->max || adc < chip->gainlevel->min) {
294 (adc > chip->gainlevel->max) ?
295 chip->gainlevel++ : chip->gainlevel--;
297 i2c_smbus_write_byte_data(client,
298 TSL2563_CMD | TSL2563_REG_TIMING,
299 chip->gainlevel->gaintime);
301 tsl2563_wait_adc(chip);
302 tsl2563_wait_adc(chip);
309 static int tsl2563_get_adc(struct tsl2563_chip *chip)
311 struct i2c_client *client = chip->client;
316 if (chip->state.event != PM_EVENT_ON)
319 if (!chip->int_enabled) {
320 cancel_delayed_work(&chip->poweroff_work);
322 if (!tsl2563_get_power(chip)) {
323 ret = tsl2563_set_power(chip, 1);
326 ret = tsl2563_configure(chip);
329 tsl2563_wait_adc(chip);
334 ret = i2c_smbus_read_word_data(client,
335 TSL2563_CMD | TSL2563_REG_DATA0LOW);
340 ret = i2c_smbus_read_word_data(client,
341 TSL2563_CMD | TSL2563_REG_DATA1LOW);
346 retry = tsl2563_adjust_gainlevel(chip, adc0);
349 chip->data0 = normalize_adc(adc0, chip->gainlevel->gaintime);
350 chip->data1 = normalize_adc(adc1, chip->gainlevel->gaintime);
352 if (!chip->int_enabled)
353 schedule_delayed_work(&chip->poweroff_work, 5 * HZ);
360 static inline int calib_to_sysfs(u32 calib)
362 return (int) (((calib * CALIB_BASE_SYSFS) +
363 CALIB_FRAC_HALF) >> CALIB_FRAC_BITS);
366 static inline u32 calib_from_sysfs(int value)
368 return (((u32) value) << CALIB_FRAC_BITS) / CALIB_BASE_SYSFS;
372 * Conversions between lux and ADC values.
374 * The basic formula is lux = c0 * adc0 - c1 * adc1, where c0 and c1 are
375 * appropriate constants. Different constants are needed for different
376 * kinds of light, determined by the ratio adc1/adc0 (basically the ratio
377 * of the intensities in infrared and visible wavelengths). lux_table below
378 * lists the upper threshold of the adc1/adc0 ratio and the corresponding
382 struct tsl2563_lux_coeff {
383 unsigned long ch_ratio;
384 unsigned long ch0_coeff;
385 unsigned long ch1_coeff;
388 static const struct tsl2563_lux_coeff lux_table[] = {
390 .ch_ratio = FRAC10K(1300),
391 .ch0_coeff = FRAC10K(315),
392 .ch1_coeff = FRAC10K(262),
394 .ch_ratio = FRAC10K(2600),
395 .ch0_coeff = FRAC10K(337),
396 .ch1_coeff = FRAC10K(430),
398 .ch_ratio = FRAC10K(3900),
399 .ch0_coeff = FRAC10K(363),
400 .ch1_coeff = FRAC10K(529),
402 .ch_ratio = FRAC10K(5200),
403 .ch0_coeff = FRAC10K(392),
404 .ch1_coeff = FRAC10K(605),
406 .ch_ratio = FRAC10K(6500),
407 .ch0_coeff = FRAC10K(229),
408 .ch1_coeff = FRAC10K(291),
410 .ch_ratio = FRAC10K(8000),
411 .ch0_coeff = FRAC10K(157),
412 .ch1_coeff = FRAC10K(180),
414 .ch_ratio = FRAC10K(13000),
415 .ch0_coeff = FRAC10K(34),
416 .ch1_coeff = FRAC10K(26),
418 .ch_ratio = ULONG_MAX,
425 * Convert normalized, scaled ADC values to lux.
427 static unsigned int adc_to_lux(u32 adc0, u32 adc1)
429 const struct tsl2563_lux_coeff *lp = lux_table;
430 unsigned long ratio, lux, ch0 = adc0, ch1 = adc1;
432 ratio = ch0 ? ((ch1 << ADC_FRAC_BITS) / ch0) : ULONG_MAX;
434 while (lp->ch_ratio < ratio)
437 lux = ch0 * lp->ch0_coeff - ch1 * lp->ch1_coeff;
439 return (unsigned int) (lux >> ADC_FRAC_BITS);
442 /*--------------------------------------------------------------*/
443 /* Sysfs interface */
444 /*--------------------------------------------------------------*/
447 /* Apply calibration coefficient to ADC count. */
448 static u32 calib_adc(u32 adc, u32 calib)
450 unsigned long scaled = adc;
453 scaled >>= CALIB_FRAC_BITS;
458 static int tsl2563_write_raw(struct iio_dev *indio_dev,
459 struct iio_chan_spec const *chan,
464 struct tsl2563_chip *chip = iio_priv(indio_dev);
466 if (chan->channel == 0)
467 chip->calib0 = calib_from_sysfs(val);
469 chip->calib1 = calib_from_sysfs(val);
474 static int tsl2563_read_raw(struct iio_dev *indio_dev,
475 struct iio_chan_spec const *chan,
482 struct tsl2563_chip *chip = iio_priv(indio_dev);
484 mutex_lock(&chip->lock);
487 switch (chan->type) {
489 ret = tsl2563_get_adc(chip);
492 calib0 = calib_adc(chip->data0, chip->calib0) *
493 chip->cover_comp_gain;
494 calib1 = calib_adc(chip->data1, chip->calib1) *
495 chip->cover_comp_gain;
496 *val = adc_to_lux(calib0, calib1);
500 ret = tsl2563_get_adc(chip);
503 if (chan->channel == 0)
514 case (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE):
515 if (chan->channel == 0)
516 *val = calib_to_sysfs(chip->calib0);
518 *val = calib_to_sysfs(chip->calib1);
526 mutex_unlock(&chip->lock);
530 #define INFO_MASK (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE)
531 #define EVENT_MASK (IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_RISING) | \
532 IIO_EV_BIT(IIO_EV_TYPE_THRESH, IIO_EV_DIR_FALLING))
533 #define IIO_CHAN_2563(type, mod, proc, chan, imask, emask) \
534 IIO_CHAN(type, mod, 1, proc, NULL, chan, 0, imask, 0, 0, {}, emask)
536 static const struct iio_chan_spec tsl2563_channels[] = {
537 IIO_CHAN_2563(IIO_LIGHT, 0, 1, 0, 0, 0),
538 IIO_CHAN_2563(IIO_INTENSITY, 1, 0, 0, INFO_MASK, EVENT_MASK),
539 IIO_CHAN_2563(IIO_INTENSITY, 1, 0, 1, INFO_MASK, 0),
542 static int tsl2563_read_thresh(struct iio_dev *indio_dev,
546 struct tsl2563_chip *chip = iio_priv(indio_dev);
548 switch (IIO_EVENT_CODE_EXTRACT_DIR(event_code)) {
549 case IIO_EV_DIR_RISING:
550 *val = chip->high_thres;
552 case IIO_EV_DIR_FALLING:
553 *val = chip->low_thres;
562 static ssize_t tsl2563_write_thresh(struct iio_dev *indio_dev,
566 struct tsl2563_chip *chip = iio_priv(indio_dev);
570 if (IIO_EVENT_CODE_EXTRACT_DIR(event_code) == IIO_EV_DIR_RISING)
571 address = TSL2563_REG_HIGHLOW;
573 address = TSL2563_REG_LOWLOW;
574 mutex_lock(&chip->lock);
575 ret = i2c_smbus_write_byte_data(chip->client, TSL2563_CMD | address,
579 ret = i2c_smbus_write_byte_data(chip->client,
580 TSL2563_CMD | (address + 1),
582 if (IIO_EVENT_CODE_EXTRACT_DIR(event_code) == IIO_EV_DIR_RISING)
583 chip->high_thres = val;
585 chip->low_thres = val;
588 mutex_unlock(&chip->lock);
593 static irqreturn_t tsl2563_event_handler(int irq, void *private)
595 struct iio_dev *dev_info = private;
596 struct tsl2563_chip *chip = iio_priv(dev_info);
598 iio_push_event(dev_info, 0,
599 IIO_UNMOD_EVENT_CODE(IIO_EV_CLASS_LIGHT,
605 /* clear the interrupt and push the event */
606 i2c_smbus_write_byte(chip->client, TSL2563_CMD | TSL2563_CLEARINT);
610 static int tsl2563_write_interrupt_config(struct iio_dev *indio_dev,
614 struct tsl2563_chip *chip = iio_priv(indio_dev);
617 mutex_lock(&chip->lock);
618 if (state && !(chip->intr & 0x30)) {
621 /* ensure the chip is actually on */
622 cancel_delayed_work(&chip->poweroff_work);
623 if (!tsl2563_get_power(chip)) {
624 ret = tsl2563_set_power(chip, 1);
627 ret = tsl2563_configure(chip);
631 ret = i2c_smbus_write_byte_data(chip->client,
632 TSL2563_CMD | TSL2563_REG_INT,
634 chip->int_enabled = true;
637 if (!state && (chip->intr & 0x30)) {
639 ret = i2c_smbus_write_byte_data(chip->client,
640 TSL2563_CMD | TSL2563_REG_INT,
642 chip->int_enabled = false;
643 /* now the interrupt is not enabled, we can go to sleep */
644 schedule_delayed_work(&chip->poweroff_work, 5 * HZ);
647 mutex_unlock(&chip->lock);
652 static int tsl2563_read_interrupt_config(struct iio_dev *indio_dev,
655 struct tsl2563_chip *chip = iio_priv(indio_dev);
658 mutex_lock(&chip->lock);
659 ret = i2c_smbus_read_byte_data(chip->client,
660 TSL2563_CMD | TSL2563_REG_INT);
661 mutex_unlock(&chip->lock);
664 ret = !!(ret & 0x30);
670 /*--------------------------------------------------------------*/
671 /* Probe, Attach, Remove */
672 /*--------------------------------------------------------------*/
673 static struct i2c_driver tsl2563_i2c_driver;
675 static const struct iio_info tsl2563_info_no_irq = {
676 .driver_module = THIS_MODULE,
677 .read_raw = &tsl2563_read_raw,
678 .write_raw = &tsl2563_write_raw,
681 static const struct iio_info tsl2563_info = {
682 .driver_module = THIS_MODULE,
683 .num_interrupt_lines = 1,
684 .read_raw = &tsl2563_read_raw,
685 .write_raw = &tsl2563_write_raw,
686 .read_event_value = &tsl2563_read_thresh,
687 .write_event_value = &tsl2563_write_thresh,
688 .read_event_config = &tsl2563_read_interrupt_config,
689 .write_event_config = &tsl2563_write_interrupt_config,
692 static int __devinit tsl2563_probe(struct i2c_client *client,
693 const struct i2c_device_id *device_id)
695 struct iio_dev *indio_dev;
696 struct tsl2563_chip *chip;
697 struct tsl2563_platform_data *pdata = client->dev.platform_data;
702 indio_dev = iio_allocate_device(sizeof(*chip));
706 chip = iio_priv(indio_dev);
708 i2c_set_clientdata(client, chip);
709 chip->client = client;
711 err = tsl2563_detect(chip);
713 dev_err(&client->dev, "device not found, error %d\n", -err);
717 err = tsl2563_read_id(chip, &id);
721 mutex_init(&chip->lock);
723 /* Default values used until userspace says otherwise */
724 chip->low_thres = 0x0;
725 chip->high_thres = 0xffff;
726 chip->gainlevel = tsl2563_gainlevel_table;
727 chip->intr = TSL2563_INT_PERSIST(4);
728 chip->calib0 = calib_from_sysfs(CALIB_BASE_SYSFS);
729 chip->calib1 = calib_from_sysfs(CALIB_BASE_SYSFS);
732 chip->cover_comp_gain = pdata->cover_comp_gain;
734 chip->cover_comp_gain = 1;
736 dev_info(&client->dev, "model %d, rev. %d\n", id >> 4, id & 0x0f);
737 indio_dev->name = client->name;
738 indio_dev->channels = tsl2563_channels;
739 indio_dev->num_channels = ARRAY_SIZE(tsl2563_channels);
740 indio_dev->dev.parent = &client->dev;
741 indio_dev->modes = INDIO_DIRECT_MODE;
743 indio_dev->info = &tsl2563_info;
745 indio_dev->info = &tsl2563_info_no_irq;
746 ret = iio_device_register(indio_dev);
750 ret = request_threaded_irq(client->irq,
752 &tsl2563_event_handler,
753 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
759 err = tsl2563_configure(chip);
763 INIT_DELAYED_WORK(&chip->poweroff_work, tsl2563_poweroff_work);
764 /* The interrupt cannot yet be enabled so this is fine without lock */
765 schedule_delayed_work(&chip->poweroff_work, 5 * HZ);
770 free_irq(client->irq, indio_dev);
772 iio_device_unregister(indio_dev);
778 static int tsl2563_remove(struct i2c_client *client)
780 struct tsl2563_chip *chip = i2c_get_clientdata(client);
781 struct iio_dev *indio_dev = iio_priv_to_dev(chip);
782 if (!chip->int_enabled)
783 cancel_delayed_work(&chip->poweroff_work);
784 /* Ensure that interrupts are disabled - then flush any bottom halves */
786 i2c_smbus_write_byte_data(chip->client, TSL2563_CMD | TSL2563_REG_INT,
788 flush_scheduled_work();
789 tsl2563_set_power(chip, 0);
791 free_irq(client->irq, indio_dev);
792 iio_device_unregister(indio_dev);
797 static int tsl2563_suspend(struct i2c_client *client, pm_message_t state)
799 struct tsl2563_chip *chip = i2c_get_clientdata(client);
802 mutex_lock(&chip->lock);
804 ret = tsl2563_set_power(chip, 0);
811 mutex_unlock(&chip->lock);
815 static int tsl2563_resume(struct i2c_client *client)
817 struct tsl2563_chip *chip = i2c_get_clientdata(client);
820 mutex_lock(&chip->lock);
822 ret = tsl2563_set_power(chip, 1);
826 ret = tsl2563_configure(chip);
830 chip->state.event = PM_EVENT_ON;
833 mutex_unlock(&chip->lock);
837 static const struct i2c_device_id tsl2563_id[] = {
844 MODULE_DEVICE_TABLE(i2c, tsl2563_id);
846 static struct i2c_driver tsl2563_i2c_driver = {
850 .suspend = tsl2563_suspend,
851 .resume = tsl2563_resume,
852 .probe = tsl2563_probe,
853 .remove = __devexit_p(tsl2563_remove),
854 .id_table = tsl2563_id,
857 static int __init tsl2563_init(void)
859 return i2c_add_driver(&tsl2563_i2c_driver);
862 static void __exit tsl2563_exit(void)
864 i2c_del_driver(&tsl2563_i2c_driver);
867 MODULE_AUTHOR("Nokia Corporation");
868 MODULE_DESCRIPTION("tsl2563 light sensor driver");
869 MODULE_LICENSE("GPL");
871 module_init(tsl2563_init);
872 module_exit(tsl2563_exit);