staging:iio: Do not use bitmasks for channel info addresses
[deliverable/linux.git] / drivers / staging / iio / light / isl29018.c
CommitLineData
94042874
RK
1/*
2 * A iio driver for the light sensor ISL 29018.
3 *
4 * IIO driver for monitoring ambient light intensity in luxi, proximity
5 * sensing and infrared sensing.
6 *
7 * Copyright (c) 2010, NVIDIA Corporation.
8 *
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.
13 *
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
17 * more details.
18 *
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.
22 */
23
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/slab.h>
30#include "../iio.h"
9dd1cb30 31#include "../sysfs.h"
94042874
RK
32#define CONVERSION_TIME_MS 100
33
34#define ISL29018_REG_ADD_COMMAND1 0x00
35#define COMMMAND1_OPMODE_SHIFT 5
36#define COMMMAND1_OPMODE_MASK (7 << COMMMAND1_OPMODE_SHIFT)
37#define COMMMAND1_OPMODE_POWER_DOWN 0
38#define COMMMAND1_OPMODE_ALS_ONCE 1
39#define COMMMAND1_OPMODE_IR_ONCE 2
40#define COMMMAND1_OPMODE_PROX_ONCE 3
41
42#define ISL29018_REG_ADD_COMMANDII 0x01
43#define COMMANDII_RESOLUTION_SHIFT 2
44#define COMMANDII_RESOLUTION_MASK (0x3 << COMMANDII_RESOLUTION_SHIFT)
45
46#define COMMANDII_RANGE_SHIFT 0
47#define COMMANDII_RANGE_MASK (0x3 << COMMANDII_RANGE_SHIFT)
48
49#define COMMANDII_SCHEME_SHIFT 7
50#define COMMANDII_SCHEME_MASK (0x1 << COMMANDII_SCHEME_SHIFT)
51
52#define ISL29018_REG_ADD_DATA_LSB 0x02
53#define ISL29018_REG_ADD_DATA_MSB 0x03
25d7315a 54#define ISL29018_MAX_REGS (ISL29018_REG_ADD_DATA_MSB+1)
94042874 55
176f9f29
GG
56#define ISL29018_REG_TEST 0x08
57#define ISL29018_TEST_SHIFT 0
58#define ISL29018_TEST_MASK (0xFF << ISL29018_TEST_SHIFT)
59
94042874 60struct isl29018_chip {
94042874
RK
61 struct i2c_client *client;
62 struct mutex lock;
6d1ad0f8 63 unsigned int lux_scale;
94042874
RK
64 unsigned int range;
65 unsigned int adc_bit;
66 int prox_scheme;
67 u8 reg_cache[ISL29018_MAX_REGS];
68};
69
70static int isl29018_write_data(struct i2c_client *client, u8 reg,
71 u8 val, u8 mask, u8 shift)
72{
25d7315a
JC
73 u8 regval = val;
74 int ret;
152d52cf 75 struct isl29018_chip *chip = iio_priv(i2c_get_clientdata(client));
94042874 76
25d7315a
JC
77 /* don't cache or mask REG_TEST */
78 if (reg < ISL29018_MAX_REGS) {
79 regval = chip->reg_cache[reg];
80 regval &= ~mask;
81 regval |= val << shift;
82 }
94042874
RK
83
84 ret = i2c_smbus_write_byte_data(client, reg, regval);
85 if (ret) {
86 dev_err(&client->dev, "Write to device fails status %x\n", ret);
25d7315a
JC
87 } else {
88 /* don't update cache on err */
89 if (reg < ISL29018_MAX_REGS)
90 chip->reg_cache[reg] = regval;
94042874 91 }
94042874 92
25d7315a 93 return ret;
94042874
RK
94}
95
96static int isl29018_set_range(struct i2c_client *client, unsigned long range,
97 unsigned int *new_range)
98{
99 static const unsigned long supp_ranges[] = {1000, 4000, 16000, 64000};
100 int i;
101
102 for (i = 0; i < ARRAY_SIZE(supp_ranges); ++i) {
103 if (range <= supp_ranges[i]) {
104 *new_range = (unsigned int)supp_ranges[i];
105 break;
106 }
107 }
108
109 if (i >= ARRAY_SIZE(supp_ranges))
110 return -EINVAL;
111
112 return isl29018_write_data(client, ISL29018_REG_ADD_COMMANDII,
113 i, COMMANDII_RANGE_MASK, COMMANDII_RANGE_SHIFT);
114}
115
116static int isl29018_set_resolution(struct i2c_client *client,
117 unsigned long adcbit, unsigned int *conf_adc_bit)
118{
119 static const unsigned long supp_adcbit[] = {16, 12, 8, 4};
120 int i;
121
122 for (i = 0; i < ARRAY_SIZE(supp_adcbit); ++i) {
123 if (adcbit >= supp_adcbit[i]) {
124 *conf_adc_bit = (unsigned int)supp_adcbit[i];
125 break;
126 }
127 }
128
129 if (i >= ARRAY_SIZE(supp_adcbit))
130 return -EINVAL;
131
132 return isl29018_write_data(client, ISL29018_REG_ADD_COMMANDII,
133 i, COMMANDII_RESOLUTION_MASK,
134 COMMANDII_RESOLUTION_SHIFT);
135}
136
137static int isl29018_read_sensor_input(struct i2c_client *client, int mode)
138{
139 int status;
140 int lsb;
141 int msb;
142
143 /* Set mode */
144 status = isl29018_write_data(client, ISL29018_REG_ADD_COMMAND1,
145 mode, COMMMAND1_OPMODE_MASK, COMMMAND1_OPMODE_SHIFT);
146 if (status) {
147 dev_err(&client->dev, "Error in setting operating mode\n");
148 return status;
149 }
150 msleep(CONVERSION_TIME_MS);
151 lsb = i2c_smbus_read_byte_data(client, ISL29018_REG_ADD_DATA_LSB);
152 if (lsb < 0) {
153 dev_err(&client->dev, "Error in reading LSB DATA\n");
154 return lsb;
155 }
156
157 msb = i2c_smbus_read_byte_data(client, ISL29018_REG_ADD_DATA_MSB);
158 if (msb < 0) {
159 dev_err(&client->dev, "Error in reading MSB DATA\n");
160 return msb;
161 }
162 dev_vdbg(&client->dev, "MSB 0x%x and LSB 0x%x\n", msb, lsb);
163
164 return (msb << 8) | lsb;
165}
166
167static int isl29018_read_lux(struct i2c_client *client, int *lux)
168{
169 int lux_data;
152d52cf 170 struct isl29018_chip *chip = iio_priv(i2c_get_clientdata(client));
94042874
RK
171
172 lux_data = isl29018_read_sensor_input(client,
173 COMMMAND1_OPMODE_ALS_ONCE);
174
175 if (lux_data < 0)
176 return lux_data;
177
6d1ad0f8 178 *lux = (lux_data * chip->range * chip->lux_scale) >> chip->adc_bit;
94042874
RK
179
180 return 0;
181}
182
183static int isl29018_read_ir(struct i2c_client *client, int *ir)
184{
185 int ir_data;
186
187 ir_data = isl29018_read_sensor_input(client, COMMMAND1_OPMODE_IR_ONCE);
188
189 if (ir_data < 0)
190 return ir_data;
191
192 *ir = ir_data;
193
194 return 0;
195}
196
197static int isl29018_read_proximity_ir(struct i2c_client *client, int scheme,
198 int *near_ir)
199{
200 int status;
201 int prox_data = -1;
202 int ir_data = -1;
203
204 /* Do proximity sensing with required scheme */
205 status = isl29018_write_data(client, ISL29018_REG_ADD_COMMANDII,
206 scheme, COMMANDII_SCHEME_MASK, COMMANDII_SCHEME_SHIFT);
207 if (status) {
208 dev_err(&client->dev, "Error in setting operating mode\n");
209 return status;
210 }
211
212 prox_data = isl29018_read_sensor_input(client,
213 COMMMAND1_OPMODE_PROX_ONCE);
214 if (prox_data < 0)
215 return prox_data;
216
217 if (scheme == 1) {
218 *near_ir = prox_data;
219 return 0;
220 }
221
222 ir_data = isl29018_read_sensor_input(client,
223 COMMMAND1_OPMODE_IR_ONCE);
224
225 if (ir_data < 0)
226 return ir_data;
227
228 if (prox_data >= ir_data)
229 *near_ir = prox_data - ir_data;
230 else
231 *near_ir = 0;
232
233 return 0;
234}
235
94042874
RK
236/* Sysfs interface */
237/* range */
238static ssize_t show_range(struct device *dev,
239 struct device_attribute *attr, char *buf)
240{
241 struct iio_dev *indio_dev = dev_get_drvdata(dev);
927afbec 242 struct isl29018_chip *chip = iio_priv(indio_dev);
94042874
RK
243
244 return sprintf(buf, "%u\n", chip->range);
245}
246
247static ssize_t store_range(struct device *dev,
248 struct device_attribute *attr, const char *buf, size_t count)
249{
250 struct iio_dev *indio_dev = dev_get_drvdata(dev);
927afbec 251 struct isl29018_chip *chip = iio_priv(indio_dev);
94042874
RK
252 struct i2c_client *client = chip->client;
253 int status;
254 unsigned long lval;
255 unsigned int new_range;
256
257 if (strict_strtoul(buf, 10, &lval))
258 return -EINVAL;
259
260 if (!(lval == 1000UL || lval == 4000UL ||
261 lval == 16000UL || lval == 64000UL)) {
262 dev_err(dev, "The range is not supported\n");
263 return -EINVAL;
264 }
265
266 mutex_lock(&chip->lock);
267 status = isl29018_set_range(client, lval, &new_range);
268 if (status < 0) {
269 mutex_unlock(&chip->lock);
270 dev_err(dev, "Error in setting max range\n");
271 return status;
272 }
273 chip->range = new_range;
274 mutex_unlock(&chip->lock);
275
276 return count;
277}
278
279/* resolution */
280static ssize_t show_resolution(struct device *dev,
281 struct device_attribute *attr, char *buf)
282{
283 struct iio_dev *indio_dev = dev_get_drvdata(dev);
927afbec 284 struct isl29018_chip *chip = iio_priv(indio_dev);
94042874
RK
285
286 return sprintf(buf, "%u\n", chip->adc_bit);
287}
288
289static ssize_t store_resolution(struct device *dev,
290 struct device_attribute *attr, const char *buf, size_t count)
291{
292 struct iio_dev *indio_dev = dev_get_drvdata(dev);
927afbec 293 struct isl29018_chip *chip = iio_priv(indio_dev);
94042874
RK
294 struct i2c_client *client = chip->client;
295 int status;
296 unsigned long lval;
297 unsigned int new_adc_bit;
298
299 if (strict_strtoul(buf, 10, &lval))
300 return -EINVAL;
301 if (!(lval == 4 || lval == 8 || lval == 12 || lval == 16)) {
302 dev_err(dev, "The resolution is not supported\n");
303 return -EINVAL;
304 }
305
306 mutex_lock(&chip->lock);
307 status = isl29018_set_resolution(client, lval, &new_adc_bit);
308 if (status < 0) {
309 mutex_unlock(&chip->lock);
310 dev_err(dev, "Error in setting resolution\n");
311 return status;
312 }
313 chip->adc_bit = new_adc_bit;
314 mutex_unlock(&chip->lock);
315
316 return count;
317}
318
319/* proximity scheme */
320static ssize_t show_prox_infrared_supression(struct device *dev,
321 struct device_attribute *attr, char *buf)
322{
323 struct iio_dev *indio_dev = dev_get_drvdata(dev);
927afbec 324 struct isl29018_chip *chip = iio_priv(indio_dev);
94042874
RK
325
326 /* return the "proximity scheme" i.e. if the chip does on chip
327 infrared supression (1 means perform on chip supression) */
328 return sprintf(buf, "%d\n", chip->prox_scheme);
329}
330
331static ssize_t store_prox_infrared_supression(struct device *dev,
332 struct device_attribute *attr, const char *buf, size_t count)
333{
334 struct iio_dev *indio_dev = dev_get_drvdata(dev);
927afbec 335 struct isl29018_chip *chip = iio_priv(indio_dev);
94042874
RK
336 unsigned long lval;
337
338 if (strict_strtoul(buf, 10, &lval))
339 return -EINVAL;
340 if (!(lval == 0UL || lval == 1UL)) {
341 dev_err(dev, "The mode is not supported\n");
342 return -EINVAL;
343 }
344
345 /* get the "proximity scheme" i.e. if the chip does on chip
346 infrared supression (1 means perform on chip supression) */
347 mutex_lock(&chip->lock);
348 chip->prox_scheme = (int)lval;
349 mutex_unlock(&chip->lock);
350
351 return count;
352}
353
01e57c57
BF
354/* Channel IO */
355static int isl29018_write_raw(struct iio_dev *indio_dev,
356 struct iio_chan_spec const *chan,
357 int val,
358 int val2,
359 long mask)
94042874 360{
01e57c57
BF
361 struct isl29018_chip *chip = iio_priv(indio_dev);
362 int ret = -EINVAL;
94042874 363
01e57c57 364 mutex_lock(&chip->lock);
924f8a21 365 if (mask == IIO_CHAN_INFO_CALIBSCALE_SEPARATE &&
01e57c57
BF
366 chan->type == IIO_LIGHT) {
367 chip->lux_scale = val;
368 ret = 0;
369 }
370 mutex_unlock(&chip->lock);
371
372 return 0;
94042874
RK
373}
374
01e57c57
BF
375static int isl29018_read_raw(struct iio_dev *indio_dev,
376 struct iio_chan_spec const *chan,
377 int *val,
378 int *val2,
379 long mask)
94042874 380{
01e57c57
BF
381 int ret = -EINVAL;
382 struct isl29018_chip *chip = iio_priv(indio_dev);
383 struct i2c_client *client = chip->client;
384
385 mutex_lock(&chip->lock);
386 switch (mask) {
387 case 0:
388 switch (chan->type) {
389 case IIO_LIGHT:
390 ret = isl29018_read_lux(client, val);
391 break;
392 case IIO_INTENSITY:
393 ret = isl29018_read_ir(client, val);
394 break;
395 case IIO_PROXIMITY:
396 ret = isl29018_read_proximity_ir(client,
397 chip->prox_scheme, val);
398 break;
399 default:
400 break;
401 }
402 if (!ret)
403 ret = IIO_VAL_INT;
404 break;
924f8a21 405 case IIO_CHAN_INFO_CALIBSCALE_SEPARATE:
01e57c57
BF
406 if (chan->type == IIO_LIGHT) {
407 *val = chip->lux_scale;
408 ret = IIO_VAL_INT;
409 }
410 break;
411 default:
412 break;
413 }
414 mutex_unlock(&chip->lock);
415 return ret;
94042874
RK
416}
417
01e57c57
BF
418static const struct iio_chan_spec isl29018_channels[] = {
419 {
420 .type = IIO_LIGHT,
421 .indexed = 1,
422 .channel = 0,
4a705130 423 .processed_val = IIO_PROCESSED,
01e57c57
BF
424 .info_mask = (1 << IIO_CHAN_INFO_CALIBSCALE_SEPARATE),
425 }, {
426 .type = IIO_INTENSITY,
427 .modified = 1,
428 .channel2 = IIO_MOD_LIGHT_IR,
429 }, {
430 /* Unindexed in current ABI. But perhaps it should be. */
431 .type = IIO_PROXIMITY,
432 }
433};
434
94042874
RK
435static IIO_DEVICE_ATTR(range, S_IRUGO | S_IWUSR, show_range, store_range, 0);
436static IIO_CONST_ATTR(range_available, "1000 4000 16000 64000");
437static IIO_CONST_ATTR(adc_resolution_available, "4 8 12 16");
438static IIO_DEVICE_ATTR(adc_resolution, S_IRUGO | S_IWUSR,
439 show_resolution, store_resolution, 0);
440static IIO_DEVICE_ATTR(proximity_on_chip_ambient_infrared_supression,
441 S_IRUGO | S_IWUSR,
442 show_prox_infrared_supression,
443 store_prox_infrared_supression, 0);
94042874
RK
444
445#define ISL29018_DEV_ATTR(name) (&iio_dev_attr_##name.dev_attr.attr)
446#define ISL29018_CONST_ATTR(name) (&iio_const_attr_##name.dev_attr.attr)
447static struct attribute *isl29018_attributes[] = {
94042874
RK
448 ISL29018_DEV_ATTR(range),
449 ISL29018_CONST_ATTR(range_available),
450 ISL29018_DEV_ATTR(adc_resolution),
451 ISL29018_CONST_ATTR(adc_resolution_available),
452 ISL29018_DEV_ATTR(proximity_on_chip_ambient_infrared_supression),
94042874
RK
453 NULL
454};
455
456static const struct attribute_group isl29108_group = {
457 .attrs = isl29018_attributes,
458};
459
460static int isl29018_chip_init(struct i2c_client *client)
461{
152d52cf 462 struct isl29018_chip *chip = iio_priv(i2c_get_clientdata(client));
94042874
RK
463 int status;
464 int new_adc_bit;
465 unsigned int new_range;
466
467 memset(chip->reg_cache, 0, sizeof(chip->reg_cache));
468
176f9f29
GG
469 /* Code added per Intersil Application Note 1534:
470 * When VDD sinks to approximately 1.8V or below, some of
471 * the part's registers may change their state. When VDD
472 * recovers to 2.25V (or greater), the part may thus be in an
473 * unknown mode of operation. The user can return the part to
474 * a known mode of operation either by (a) setting VDD = 0V for
475 * 1 second or more and then powering back up with a slew rate
476 * of 0.5V/ms or greater, or (b) via I2C disable all ALS/PROX
477 * conversions, clear the test registers, and then rewrite all
478 * registers to the desired values.
479 * ...
480 * FOR ISL29011, ISL29018, ISL29021, ISL29023
481 * 1. Write 0x00 to register 0x08 (TEST)
482 * 2. Write 0x00 to register 0x00 (CMD1)
483 * 3. Rewrite all registers to the desired values
484 *
485 * ISL29018 Data Sheet (FN6619.1, Feb 11, 2010) essentially says
486 * the same thing EXCEPT the data sheet asks for a 1ms delay after
487 * writing the CMD1 register.
488 */
489 status = isl29018_write_data(client, ISL29018_REG_TEST, 0,
490 ISL29018_TEST_MASK, ISL29018_TEST_SHIFT);
491 if (status < 0) {
492 dev_err(&client->dev, "Failed to clear isl29018 TEST reg."
493 "(%d)\n", status);
494 return status;
495 }
496
497 /* See Intersil AN1534 comments above.
498 * "Operating Mode" (COMMAND1) register is reprogrammed when
499 * data is read from the device.
500 */
501 status = isl29018_write_data(client, ISL29018_REG_ADD_COMMAND1, 0,
502 0xff, 0);
503 if (status < 0) {
504 dev_err(&client->dev, "Failed to clear isl29018 CMD1 reg."
505 "(%d)\n", status);
506 return status;
507 }
508
509 msleep(1); /* per data sheet, page 10 */
510
94042874
RK
511 /* set defaults */
512 status = isl29018_set_range(client, chip->range, &new_range);
513 if (status < 0) {
514 dev_err(&client->dev, "Init of isl29018 fails\n");
515 return status;
516 }
517
518 status = isl29018_set_resolution(client, chip->adc_bit,
519 &new_adc_bit);
520
521 return 0;
522}
523
6fe8135f
JC
524static const struct iio_info isl29108_info = {
525 .attrs = &isl29108_group,
526 .driver_module = THIS_MODULE,
01e57c57
BF
527 .read_raw = &isl29018_read_raw,
528 .write_raw = &isl29018_write_raw,
6fe8135f
JC
529};
530
94042874
RK
531static int __devinit isl29018_probe(struct i2c_client *client,
532 const struct i2c_device_id *id)
533{
534 struct isl29018_chip *chip;
927afbec 535 struct iio_dev *indio_dev;
94042874
RK
536 int err;
537
927afbec
JC
538 indio_dev = iio_allocate_device(sizeof(*chip));
539 if (indio_dev == NULL) {
540 dev_err(&client->dev, "iio allocation fails\n");
94042874
RK
541 err = -ENOMEM;
542 goto exit;
543 }
927afbec 544 chip = iio_priv(indio_dev);
94042874 545
927afbec 546 i2c_set_clientdata(client, indio_dev);
94042874
RK
547 chip->client = client;
548
549 mutex_init(&chip->lock);
550
6d1ad0f8 551 chip->lux_scale = 1;
94042874
RK
552 chip->range = 1000;
553 chip->adc_bit = 16;
554
555 err = isl29018_chip_init(client);
556 if (err)
927afbec 557 goto exit_iio_free;
94042874 558
927afbec 559 indio_dev->info = &isl29108_info;
01e57c57
BF
560 indio_dev->channels = isl29018_channels;
561 indio_dev->num_channels = ARRAY_SIZE(isl29018_channels);
927afbec
JC
562 indio_dev->name = id->name;
563 indio_dev->dev.parent = &client->dev;
564 indio_dev->modes = INDIO_DIRECT_MODE;
565 err = iio_device_register(indio_dev);
94042874
RK
566 if (err) {
567 dev_err(&client->dev, "iio registration fails\n");
568 goto exit_iio_free;
569 }
570
571 return 0;
572exit_iio_free:
927afbec 573 iio_free_device(indio_dev);
94042874
RK
574exit:
575 return err;
576}
577
578static int __devexit isl29018_remove(struct i2c_client *client)
579{
927afbec 580 struct iio_dev *indio_dev = i2c_get_clientdata(client);
94042874
RK
581
582 dev_dbg(&client->dev, "%s()\n", __func__);
927afbec 583 iio_device_unregister(indio_dev);
d2fffd6c 584 iio_free_device(indio_dev);
94042874
RK
585
586 return 0;
587}
588
589static const struct i2c_device_id isl29018_id[] = {
590 {"isl29018", 0},
591 {}
592};
593
594MODULE_DEVICE_TABLE(i2c, isl29018_id);
595
596static struct i2c_driver isl29018_driver = {
597 .class = I2C_CLASS_HWMON,
598 .driver = {
599 .name = "isl29018",
600 .owner = THIS_MODULE,
601 },
602 .probe = isl29018_probe,
603 .remove = __devexit_p(isl29018_remove),
604 .id_table = isl29018_id,
605};
606
607static int __init isl29018_init(void)
608{
609 return i2c_add_driver(&isl29018_driver);
610}
611
612static void __exit isl29018_exit(void)
613{
614 i2c_del_driver(&isl29018_driver);
615}
616
617module_init(isl29018_init);
618module_exit(isl29018_exit);
619
620MODULE_DESCRIPTION("ISL29018 Ambient Light Sensor driver");
621MODULE_LICENSE("GPL");
This page took 0.235081 seconds and 5 git commands to generate.