2 * A iio driver for the light sensor ISL 29018.
4 * IIO driver for monitoring ambient light intensity in luxi, proximity
5 * sensing and infrared sensing.
7 * Copyright (c) 2010, NVIDIA Corporation.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 #include <linux/module.h>
25 #include <linux/i2c.h>
26 #include <linux/err.h>
27 #include <linux/mutex.h>
28 #include <linux/delay.h>
29 #include <linux/regmap.h>
30 #include <linux/slab.h>
31 #include <linux/iio/iio.h>
32 #include <linux/iio/sysfs.h>
34 #define CONVERSION_TIME_MS 100
36 #define ISL29018_REG_ADD_COMMAND1 0x00
37 #define COMMMAND1_OPMODE_SHIFT 5
38 #define COMMMAND1_OPMODE_MASK (7 << COMMMAND1_OPMODE_SHIFT)
39 #define COMMMAND1_OPMODE_POWER_DOWN 0
40 #define COMMMAND1_OPMODE_ALS_ONCE 1
41 #define COMMMAND1_OPMODE_IR_ONCE 2
42 #define COMMMAND1_OPMODE_PROX_ONCE 3
44 #define ISL29018_REG_ADD_COMMANDII 0x01
45 #define COMMANDII_RESOLUTION_SHIFT 2
46 #define COMMANDII_RESOLUTION_MASK (0x3 << COMMANDII_RESOLUTION_SHIFT)
48 #define COMMANDII_RANGE_SHIFT 0
49 #define COMMANDII_RANGE_MASK (0x3 << COMMANDII_RANGE_SHIFT)
51 #define COMMANDII_SCHEME_SHIFT 7
52 #define COMMANDII_SCHEME_MASK (0x1 << COMMANDII_SCHEME_SHIFT)
54 #define ISL29018_REG_ADD_DATA_LSB 0x02
55 #define ISL29018_REG_ADD_DATA_MSB 0x03
57 #define ISL29018_REG_TEST 0x08
58 #define ISL29018_TEST_SHIFT 0
59 #define ISL29018_TEST_MASK (0xFF << ISL29018_TEST_SHIFT)
61 struct isl29018_chip {
63 struct regmap *regmap;
65 unsigned int lux_scale;
66 unsigned int lux_uscale;
72 static int isl29018_set_range(struct isl29018_chip *chip, unsigned long range,
73 unsigned int *new_range)
75 static const unsigned long supp_ranges[] = {1000, 4000, 16000, 64000};
78 for (i = 0; i < ARRAY_SIZE(supp_ranges); ++i) {
79 if (range <= supp_ranges[i]) {
80 *new_range = (unsigned int)supp_ranges[i];
85 if (i >= ARRAY_SIZE(supp_ranges))
88 return regmap_update_bits(chip->regmap, ISL29018_REG_ADD_COMMANDII,
89 COMMANDII_RANGE_MASK, i << COMMANDII_RANGE_SHIFT);
92 static int isl29018_set_resolution(struct isl29018_chip *chip,
93 unsigned long adcbit, unsigned int *conf_adc_bit)
95 static const unsigned long supp_adcbit[] = {16, 12, 8, 4};
98 for (i = 0; i < ARRAY_SIZE(supp_adcbit); ++i) {
99 if (adcbit >= supp_adcbit[i]) {
100 *conf_adc_bit = (unsigned int)supp_adcbit[i];
105 if (i >= ARRAY_SIZE(supp_adcbit))
108 return regmap_update_bits(chip->regmap, ISL29018_REG_ADD_COMMANDII,
109 COMMANDII_RESOLUTION_MASK,
110 i << COMMANDII_RESOLUTION_SHIFT);
113 static int isl29018_read_sensor_input(struct isl29018_chip *chip, int mode)
120 status = regmap_write(chip->regmap, ISL29018_REG_ADD_COMMAND1,
121 mode << COMMMAND1_OPMODE_SHIFT);
124 "Error in setting operating mode err %d\n", status);
127 msleep(CONVERSION_TIME_MS);
128 status = regmap_read(chip->regmap, ISL29018_REG_ADD_DATA_LSB, &lsb);
131 "Error in reading LSB DATA with err %d\n", status);
135 status = regmap_read(chip->regmap, ISL29018_REG_ADD_DATA_MSB, &msb);
138 "Error in reading MSB DATA with error %d\n", status);
141 dev_vdbg(chip->dev, "MSB 0x%x and LSB 0x%x\n", msb, lsb);
143 return (msb << 8) | lsb;
146 static int isl29018_read_lux(struct isl29018_chip *chip, int *lux)
149 unsigned int data_x_range, lux_unshifted;
151 lux_data = isl29018_read_sensor_input(chip, COMMMAND1_OPMODE_ALS_ONCE);
156 /* To support fractional scaling, separate the unshifted lux
157 * into two calculations: int scaling and micro-scaling.
158 * lux_uscale ranges from 0-999999, so about 20 bits. Split
159 * the /1,000,000 in two to reduce the risk of over/underflow.
161 data_x_range = lux_data * chip->range;
162 lux_unshifted = data_x_range * chip->lux_scale;
163 lux_unshifted += data_x_range / 1000 * chip->lux_uscale / 1000;
164 *lux = lux_unshifted >> chip->adc_bit;
169 static int isl29018_read_ir(struct isl29018_chip *chip, int *ir)
173 ir_data = isl29018_read_sensor_input(chip, COMMMAND1_OPMODE_IR_ONCE);
183 static int isl29018_read_proximity_ir(struct isl29018_chip *chip, int scheme,
190 /* Do proximity sensing with required scheme */
191 status = regmap_update_bits(chip->regmap, ISL29018_REG_ADD_COMMANDII,
192 COMMANDII_SCHEME_MASK,
193 scheme << COMMANDII_SCHEME_SHIFT);
195 dev_err(chip->dev, "Error in setting operating mode\n");
199 prox_data = isl29018_read_sensor_input(chip,
200 COMMMAND1_OPMODE_PROX_ONCE);
205 *near_ir = prox_data;
209 ir_data = isl29018_read_sensor_input(chip, COMMMAND1_OPMODE_IR_ONCE);
214 if (prox_data >= ir_data)
215 *near_ir = prox_data - ir_data;
222 /* Sysfs interface */
224 static ssize_t show_range(struct device *dev,
225 struct device_attribute *attr, char *buf)
227 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
228 struct isl29018_chip *chip = iio_priv(indio_dev);
230 return sprintf(buf, "%u\n", chip->range);
233 static ssize_t store_range(struct device *dev,
234 struct device_attribute *attr, const char *buf, size_t count)
236 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
237 struct isl29018_chip *chip = iio_priv(indio_dev);
240 unsigned int new_range;
242 if (strict_strtoul(buf, 10, &lval))
245 if (!(lval == 1000UL || lval == 4000UL ||
246 lval == 16000UL || lval == 64000UL)) {
247 dev_err(dev, "The range is not supported\n");
251 mutex_lock(&chip->lock);
252 status = isl29018_set_range(chip, lval, &new_range);
254 mutex_unlock(&chip->lock);
256 "Error in setting max range with err %d\n", status);
259 chip->range = new_range;
260 mutex_unlock(&chip->lock);
266 static ssize_t show_resolution(struct device *dev,
267 struct device_attribute *attr, char *buf)
269 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
270 struct isl29018_chip *chip = iio_priv(indio_dev);
272 return sprintf(buf, "%u\n", chip->adc_bit);
275 static ssize_t store_resolution(struct device *dev,
276 struct device_attribute *attr, const char *buf, size_t count)
278 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
279 struct isl29018_chip *chip = iio_priv(indio_dev);
282 unsigned int new_adc_bit;
284 if (strict_strtoul(buf, 10, &lval))
286 if (!(lval == 4 || lval == 8 || lval == 12 || lval == 16)) {
287 dev_err(dev, "The resolution is not supported\n");
291 mutex_lock(&chip->lock);
292 status = isl29018_set_resolution(chip, lval, &new_adc_bit);
294 mutex_unlock(&chip->lock);
295 dev_err(dev, "Error in setting resolution\n");
298 chip->adc_bit = new_adc_bit;
299 mutex_unlock(&chip->lock);
304 /* proximity scheme */
305 static ssize_t show_prox_infrared_suppression(struct device *dev,
306 struct device_attribute *attr, char *buf)
308 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
309 struct isl29018_chip *chip = iio_priv(indio_dev);
311 /* return the "proximity scheme" i.e. if the chip does on chip
312 infrared suppression (1 means perform on chip suppression) */
313 return sprintf(buf, "%d\n", chip->prox_scheme);
316 static ssize_t store_prox_infrared_suppression(struct device *dev,
317 struct device_attribute *attr, const char *buf, size_t count)
319 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
320 struct isl29018_chip *chip = iio_priv(indio_dev);
323 if (strict_strtoul(buf, 10, &lval))
325 if (!(lval == 0UL || lval == 1UL)) {
326 dev_err(dev, "The mode is not supported\n");
330 /* get the "proximity scheme" i.e. if the chip does on chip
331 infrared suppression (1 means perform on chip suppression) */
332 mutex_lock(&chip->lock);
333 chip->prox_scheme = (int)lval;
334 mutex_unlock(&chip->lock);
340 static int isl29018_write_raw(struct iio_dev *indio_dev,
341 struct iio_chan_spec const *chan,
346 struct isl29018_chip *chip = iio_priv(indio_dev);
349 mutex_lock(&chip->lock);
350 if (mask == IIO_CHAN_INFO_CALIBSCALE && chan->type == IIO_LIGHT) {
351 chip->lux_scale = val;
352 /* With no write_raw_get_fmt(), val2 is a MICRO fraction. */
353 chip->lux_uscale = val2;
356 mutex_unlock(&chip->lock);
361 static int isl29018_read_raw(struct iio_dev *indio_dev,
362 struct iio_chan_spec const *chan,
368 struct isl29018_chip *chip = iio_priv(indio_dev);
370 mutex_lock(&chip->lock);
372 case IIO_CHAN_INFO_RAW:
373 case IIO_CHAN_INFO_PROCESSED:
374 switch (chan->type) {
376 ret = isl29018_read_lux(chip, val);
379 ret = isl29018_read_ir(chip, val);
382 ret = isl29018_read_proximity_ir(chip,
383 chip->prox_scheme, val);
391 case IIO_CHAN_INFO_CALIBSCALE:
392 if (chan->type == IIO_LIGHT) {
393 *val = chip->lux_scale;
394 *val2 = chip->lux_uscale;
395 ret = IIO_VAL_INT_PLUS_MICRO;
401 mutex_unlock(&chip->lock);
405 static const struct iio_chan_spec isl29018_channels[] = {
410 .info_mask = IIO_CHAN_INFO_PROCESSED_SEPARATE_BIT |
411 IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT,
413 .type = IIO_INTENSITY,
415 .info_mask = IIO_CHAN_INFO_RAW_SEPARATE_BIT,
416 .channel2 = IIO_MOD_LIGHT_IR,
418 /* Unindexed in current ABI. But perhaps it should be. */
419 .type = IIO_PROXIMITY,
420 .info_mask = IIO_CHAN_INFO_RAW_SEPARATE_BIT,
424 static IIO_DEVICE_ATTR(range, S_IRUGO | S_IWUSR, show_range, store_range, 0);
425 static IIO_CONST_ATTR(range_available, "1000 4000 16000 64000");
426 static IIO_CONST_ATTR(adc_resolution_available, "4 8 12 16");
427 static IIO_DEVICE_ATTR(adc_resolution, S_IRUGO | S_IWUSR,
428 show_resolution, store_resolution, 0);
429 static IIO_DEVICE_ATTR(proximity_on_chip_ambient_infrared_suppression,
431 show_prox_infrared_suppression,
432 store_prox_infrared_suppression, 0);
434 #define ISL29018_DEV_ATTR(name) (&iio_dev_attr_##name.dev_attr.attr)
435 #define ISL29018_CONST_ATTR(name) (&iio_const_attr_##name.dev_attr.attr)
436 static struct attribute *isl29018_attributes[] = {
437 ISL29018_DEV_ATTR(range),
438 ISL29018_CONST_ATTR(range_available),
439 ISL29018_DEV_ATTR(adc_resolution),
440 ISL29018_CONST_ATTR(adc_resolution_available),
441 ISL29018_DEV_ATTR(proximity_on_chip_ambient_infrared_suppression),
445 static const struct attribute_group isl29108_group = {
446 .attrs = isl29018_attributes,
449 static int isl29018_chip_init(struct isl29018_chip *chip)
453 unsigned int new_range;
455 /* Code added per Intersil Application Note 1534:
456 * When VDD sinks to approximately 1.8V or below, some of
457 * the part's registers may change their state. When VDD
458 * recovers to 2.25V (or greater), the part may thus be in an
459 * unknown mode of operation. The user can return the part to
460 * a known mode of operation either by (a) setting VDD = 0V for
461 * 1 second or more and then powering back up with a slew rate
462 * of 0.5V/ms or greater, or (b) via I2C disable all ALS/PROX
463 * conversions, clear the test registers, and then rewrite all
464 * registers to the desired values.
466 * FOR ISL29011, ISL29018, ISL29021, ISL29023
467 * 1. Write 0x00 to register 0x08 (TEST)
468 * 2. Write 0x00 to register 0x00 (CMD1)
469 * 3. Rewrite all registers to the desired values
471 * ISL29018 Data Sheet (FN6619.1, Feb 11, 2010) essentially says
472 * the same thing EXCEPT the data sheet asks for a 1ms delay after
473 * writing the CMD1 register.
475 status = regmap_write(chip->regmap, ISL29018_REG_TEST, 0x0);
477 dev_err(chip->dev, "Failed to clear isl29018 TEST reg."
482 /* See Intersil AN1534 comments above.
483 * "Operating Mode" (COMMAND1) register is reprogrammed when
484 * data is read from the device.
486 status = regmap_write(chip->regmap, ISL29018_REG_ADD_COMMAND1, 0);
488 dev_err(chip->dev, "Failed to clear isl29018 CMD1 reg."
493 msleep(1); /* per data sheet, page 10 */
496 status = isl29018_set_range(chip, chip->range, &new_range);
498 dev_err(chip->dev, "Init of isl29018 fails\n");
502 status = isl29018_set_resolution(chip, chip->adc_bit,
508 static const struct iio_info isl29108_info = {
509 .attrs = &isl29108_group,
510 .driver_module = THIS_MODULE,
511 .read_raw = &isl29018_read_raw,
512 .write_raw = &isl29018_write_raw,
515 static bool is_volatile_reg(struct device *dev, unsigned int reg)
518 case ISL29018_REG_ADD_DATA_LSB:
519 case ISL29018_REG_ADD_DATA_MSB:
520 case ISL29018_REG_ADD_COMMAND1:
521 case ISL29018_REG_TEST:
529 * isl29018_regmap_config: regmap configuration.
530 * Use RBTREE mechanism for caching.
532 static const struct regmap_config isl29018_regmap_config = {
535 .volatile_reg = is_volatile_reg,
536 .max_register = ISL29018_REG_TEST,
537 .num_reg_defaults_raw = ISL29018_REG_TEST + 1,
538 .cache_type = REGCACHE_RBTREE,
541 static int __devinit isl29018_probe(struct i2c_client *client,
542 const struct i2c_device_id *id)
544 struct isl29018_chip *chip;
545 struct iio_dev *indio_dev;
548 indio_dev = iio_device_alloc(sizeof(*chip));
549 if (indio_dev == NULL) {
550 dev_err(&client->dev, "iio allocation fails\n");
554 chip = iio_priv(indio_dev);
556 i2c_set_clientdata(client, indio_dev);
557 chip->dev = &client->dev;
559 mutex_init(&chip->lock);
565 chip->regmap = devm_regmap_init_i2c(client, &isl29018_regmap_config);
566 if (IS_ERR(chip->regmap)) {
567 err = PTR_ERR(chip->regmap);
568 dev_err(chip->dev, "regmap initialization failed: %d\n", err);
572 err = isl29018_chip_init(chip);
576 indio_dev->info = &isl29108_info;
577 indio_dev->channels = isl29018_channels;
578 indio_dev->num_channels = ARRAY_SIZE(isl29018_channels);
579 indio_dev->name = id->name;
580 indio_dev->dev.parent = &client->dev;
581 indio_dev->modes = INDIO_DIRECT_MODE;
582 err = iio_device_register(indio_dev);
584 dev_err(&client->dev, "iio registration fails\n");
590 iio_device_free(indio_dev);
595 static int __devexit isl29018_remove(struct i2c_client *client)
597 struct iio_dev *indio_dev = i2c_get_clientdata(client);
599 dev_dbg(&client->dev, "%s()\n", __func__);
600 iio_device_unregister(indio_dev);
601 iio_device_free(indio_dev);
606 static const struct i2c_device_id isl29018_id[] = {
611 MODULE_DEVICE_TABLE(i2c, isl29018_id);
613 static const struct of_device_id isl29018_of_match[] = {
614 { .compatible = "isil,isl29018", },
617 MODULE_DEVICE_TABLE(of, isl29018_of_match);
619 static struct i2c_driver isl29018_driver = {
620 .class = I2C_CLASS_HWMON,
623 .owner = THIS_MODULE,
624 .of_match_table = isl29018_of_match,
626 .probe = isl29018_probe,
627 .remove = __devexit_p(isl29018_remove),
628 .id_table = isl29018_id,
630 module_i2c_driver(isl29018_driver);
632 MODULE_DESCRIPTION("ISL29018 Ambient Light Sensor driver");
633 MODULE_LICENSE("GPL");