tsl2583.c 24.0 KB
Newer Older
1 2
/*
 * Device driver for monitoring ambient light intensity (lux)
3
 * within the TAOS tsl258x family of devices (tsl2580, tsl2581, tsl2583).
4 5
 *
 * Copyright (c) 2011, TAOS Corporation.
6
 * Copyright (c) 2016-2017 Brian Masney <masneyb@onstation.org>
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */

#include <linux/kernel.h>
#include <linux/i2c.h>
#include <linux/errno.h>
#include <linux/delay.h>
#include <linux/string.h>
#include <linux/mutex.h>
#include <linux/unistd.h>
#include <linux/slab.h>
27
#include <linux/module.h>
28
#include <linux/iio/iio.h>
29
#include <linux/iio/sysfs.h>
30
#include <linux/pm_runtime.h>
31 32

/* Device Registers and Masks */
33 34 35 36 37 38 39 40 41 42 43 44
#define TSL2583_CNTRL			0x00
#define TSL2583_ALS_TIME		0X01
#define TSL2583_INTERRUPT		0x02
#define TSL2583_GAIN			0x07
#define TSL2583_REVID			0x11
#define TSL2583_CHIPID			0x12
#define TSL2583_ALS_CHAN0LO		0x14
#define TSL2583_ALS_CHAN0HI		0x15
#define TSL2583_ALS_CHAN1LO		0x16
#define TSL2583_ALS_CHAN1HI		0x17
#define TSL2583_TMR_LO			0x18
#define TSL2583_TMR_HI			0x19
45 46

/* tsl2583 cmd reg masks */
47 48
#define TSL2583_CMD_REG			0x80
#define TSL2583_CMD_SPL_FN		0x60
49
#define TSL2583_CMD_ALS_INT_CLR		0x01
50 51

/* tsl2583 cntrl reg masks */
52
#define TSL2583_CNTL_ADC_ENBL		0x02
53 54
#define TSL2583_CNTL_PWR_OFF		0x00
#define TSL2583_CNTL_PWR_ON		0x01
55 56

/* tsl2583 status reg masks */
57 58
#define TSL2583_STA_ADC_VALID		0x01
#define TSL2583_STA_ADC_INTR		0x10
59 60

/* Lux calculation constants */
61
#define TSL2583_LUX_CALC_OVER_FLOW	65535
62

63 64
#define TSL2583_INTERRUPT_DISABLED	0x00

65 66 67
#define TSL2583_CHIP_ID			0x90
#define TSL2583_CHIP_ID_MASK		0xf0

68 69
#define TSL2583_POWER_OFF_DELAY_MS	2000

70
/* Per-device data */
71
struct tsl2583_als_info {
72 73 74 75 76
	u16 als_ch0;
	u16 als_ch1;
	u16 lux;
};

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
struct tsl2583_lux {
	unsigned int ratio;
	unsigned int ch0;
	unsigned int ch1;
};

static const struct tsl2583_lux tsl2583_default_lux[] = {
	{  9830,  8520, 15729 },
	{ 12452, 10807, 23344 },
	{ 14746,  6383, 11705 },
	{ 17695,  4063,  6554 },
	{     0,     0,     0 }  /* Termination segment */
};

#define TSL2583_MAX_LUX_TABLE_ENTRIES 11

93
struct tsl2583_settings {
94 95 96 97
	int als_time;
	int als_gain;
	int als_gain_trim;
	int als_cal_target;
98 99 100 101 102 103 104

	/*
	 * This structure is intentionally large to accommodate updates via
	 * sysfs. Sized to 11 = max 10 segments + 1 termination segment.
	 * Assumption is that one and only one type of glass used.
	 */
	struct tsl2583_lux als_device_lux[TSL2583_MAX_LUX_TABLE_ENTRIES];
105 106 107 108 109
};

struct tsl2583_chip {
	struct mutex als_mutex;
	struct i2c_client *client;
110 111
	struct tsl2583_als_info als_cur_info;
	struct tsl2583_settings als_settings;
112 113 114 115 116 117 118
	int als_time_scale;
	int als_saturation;
};

struct gainadj {
	s16 ch0;
	s16 ch1;
119
	s16 mean;
120 121 122 123
};

/* Index = (0 - 3) Used to validate the gain selection index */
static const struct gainadj gainadj[] = {
124 125 126 127
	{ 1, 1, 1 },
	{ 8, 8, 8 },
	{ 16, 16, 16 },
	{ 107, 115, 111 }
128 129 130 131 132 133
};

/*
 * Provides initial operational parameter defaults.
 * These defaults may be changed through the device's sysfs files.
 */
134
static void tsl2583_defaults(struct tsl2583_chip *chip)
135
{
136 137 138 139
	/*
	 * The integration time must be a multiple of 50ms and within the
	 * range [50, 600] ms.
	 */
140
	chip->als_settings.als_time = 100;
141 142 143 144 145

	/*
	 * This is an index into the gainadj table. Assume clear glass as the
	 * default.
	 */
146
	chip->als_settings.als_gain = 0;
147 148

	/* Default gain trim to account for aperture effects */
149
	chip->als_settings.als_gain_trim = 1000;
150

151
	/* Known external ALS reading used for calibration */
152
	chip->als_settings.als_cal_target = 130;
153 154 155 156

	/* Default lux table. */
	memcpy(chip->als_settings.als_device_lux, tsl2583_default_lux,
	       sizeof(tsl2583_default_lux));
157 158 159 160 161 162 163 164 165
}

/*
 * Reads and calculates current lux value.
 * The raw ch0 and ch1 values of the ambient light sensed in the last
 * integration cycle are read from the device.
 * Time scale factor array values are adjusted based on the integration time.
 * The raw values are multiplied by a scale factor, and device gain is obtained
 * using gain index. Limit checks are done next, then the ratio of a multiple
166
 * of ch1 value, to the ch0 value, is calculated. The array als_device_lux[]
167 168 169 170 171
 * declared above is then scanned to find the first ratio value that is just
 * above the ratio we just calculated. The ch0 and ch1 multiplier constants in
 * the array are then used along with the time scale factor array values, to
 * calculate the lux.
 */
172
static int tsl2583_get_lux(struct iio_dev *indio_dev)
173 174 175
{
	u16 ch0, ch1; /* separated ch0/ch1 data from device */
	u32 lux; /* raw lux calculated from device data */
176
	u64 lux64;
177 178
	u32 ratio;
	u8 buf[5];
179
	struct tsl2583_lux *p;
180
	struct tsl2583_chip *chip = iio_priv(indio_dev);
181 182
	int i, ret;

183
	ret = i2c_smbus_read_byte_data(chip->client, TSL2583_CMD_REG);
184
	if (ret < 0) {
185 186
		dev_err(&chip->client->dev, "%s: failed to read CMD_REG register\n",
			__func__);
187
		goto done;
188
	}
189

190
	/* is data new & valid */
191
	if (!(ret & TSL2583_STA_ADC_INTR)) {
192 193
		dev_err(&chip->client->dev, "%s: data not valid; returning last value\n",
			__func__);
194
		ret = chip->als_cur_info.lux; /* return LAST VALUE */
195
		goto done;
196 197 198
	}

	for (i = 0; i < 4; i++) {
199
		int reg = TSL2583_CMD_REG | (TSL2583_ALS_CHAN0LO + i);
200

201
		ret = i2c_smbus_read_byte_data(chip->client, reg);
202
		if (ret < 0) {
203 204
			dev_err(&chip->client->dev, "%s: failed to read register %x\n",
				__func__, reg);
205
			goto done;
206
		}
207
		buf[i] = ret;
208 209
	}

210
	/*
211 212 213
	 * Clear the pending interrupt status bit on the chip to allow the next
	 * integration cycle to start. This has to be done even though this
	 * driver currently does not support interrupts.
214
	 */
215
	ret = i2c_smbus_write_byte(chip->client,
216 217
				   (TSL2583_CMD_REG | TSL2583_CMD_SPL_FN |
				    TSL2583_CMD_ALS_INT_CLR));
218
	if (ret < 0) {
219 220
		dev_err(&chip->client->dev, "%s: failed to clear the interrupt bit\n",
			__func__);
221
		goto done; /* have no data, so return failure */
222 223 224 225 226 227 228 229 230 231 232 233
	}

	/* extract ALS/lux data */
	ch0 = le16_to_cpup((const __le16 *)&buf[0]);
	ch1 = le16_to_cpup((const __le16 *)&buf[2]);

	chip->als_cur_info.als_ch0 = ch0;
	chip->als_cur_info.als_ch1 = ch1;

	if ((ch0 >= chip->als_saturation) || (ch1 >= chip->als_saturation))
		goto return_max;

234
	if (!ch0) {
235 236 237 238 239
		/*
		 * The sensor appears to be in total darkness so set the
		 * calculated lux to 0 and return early to avoid a division by
		 * zero below when calculating the ratio.
		 */
240 241
		ret = 0;
		chip->als_cur_info.lux = 0;
242
		goto done;
243
	}
244

245 246
	/* calculate ratio */
	ratio = (ch1 << 15) / ch0;
247

248
	/* convert to unscaled lux using the pointer to the table */
249
	for (p = (struct tsl2583_lux *)chip->als_settings.als_device_lux;
250 251 252 253 254 255
	     p->ratio != 0 && p->ratio < ratio; p++)
		;

	if (p->ratio == 0) {
		lux = 0;
	} else {
256 257
		u32 ch0lux, ch1lux;

258
		ch0lux = ((ch0 * p->ch0) +
259 260
			  (gainadj[chip->als_settings.als_gain].ch0 >> 1))
			 / gainadj[chip->als_settings.als_gain].ch0;
261
		ch1lux = ((ch1 * p->ch1) +
262 263
			  (gainadj[chip->als_settings.als_gain].ch1 >> 1))
			 / gainadj[chip->als_settings.als_gain].ch1;
264

265 266 267 268 269 270 271 272 273 274
		/* note: lux is 31 bit max at this point */
		if (ch1lux > ch0lux) {
			dev_dbg(&chip->client->dev, "%s: No Data - Returning 0\n",
				__func__);
			ret = 0;
			chip->als_cur_info.lux = 0;
			goto done;
		}

		lux = ch0lux - ch1lux;
275 276 277 278 279 280 281 282 283
	}

	/* adjust for active time scale */
	if (chip->als_time_scale == 0)
		lux = 0;
	else
		lux = (lux + (chip->als_time_scale >> 1)) /
			chip->als_time_scale;

284 285
	/*
	 * Adjust for active gain scale.
286
	 * The tsl2583_default_lux tables above have a factor of 8192 built in,
287 288 289 290 291 292 293
	 * so we need to shift right.
	 * User-specified gain provides a multiplier.
	 * Apply user-specified gain before shifting right to retain precision.
	 * Use 64 bits to avoid overflow on multiplication.
	 * Then go back to 32 bits before division to avoid using div_u64().
	 */
	lux64 = lux;
294
	lux64 = lux64 * chip->als_settings.als_gain_trim;
295 296 297
	lux64 >>= 13;
	lux = lux64;
	lux = (lux + 500) / 1000;
298

299
	if (lux > TSL2583_LUX_CALC_OVER_FLOW) { /* check for overflow */
300
return_max:
301
		lux = TSL2583_LUX_CALC_OVER_FLOW;
302 303 304 305 306 307
	}

	/* Update the structure with the latest VALID lux. */
	chip->als_cur_info.lux = lux;
	ret = lux;

308
done:
309 310 311 312 313 314 315 316
	return ret;
}

/*
 * Obtain single reading and calculate the als_gain_trim (later used
 * to derive actual lux).
 * Return updated gain_trim value.
 */
317
static int tsl2583_als_calibrate(struct iio_dev *indio_dev)
318
{
319
	struct tsl2583_chip *chip = iio_priv(indio_dev);
320 321 322 323
	unsigned int gain_trim_val;
	int ret;
	int lux_val;

324
	ret = i2c_smbus_read_byte_data(chip->client,
325
				       TSL2583_CMD_REG | TSL2583_CNTRL);
326
	if (ret < 0) {
327
		dev_err(&chip->client->dev,
328
			"%s: failed to read from the CNTRL register\n",
329 330 331 332
			__func__);
		return ret;
	}

333 334
	if ((ret & (TSL2583_CNTL_ADC_ENBL | TSL2583_CNTL_PWR_ON))
			!= (TSL2583_CNTL_ADC_ENBL | TSL2583_CNTL_PWR_ON)) {
335
		dev_err(&chip->client->dev,
336 337
			"%s: Device is not powered on and/or ADC is not enabled\n",
			__func__);
338
		return -EINVAL;
339
	} else if ((ret & TSL2583_STA_ADC_VALID) != TSL2583_STA_ADC_VALID) {
340
		dev_err(&chip->client->dev,
341 342
			"%s: The two ADC channels have not completed an integration cycle\n",
			__func__);
343 344
		return -ENODATA;
	}
345

346
	lux_val = tsl2583_get_lux(indio_dev);
347
	if (lux_val < 0) {
348 349
		dev_err(&chip->client->dev, "%s: failed to get lux\n",
			__func__);
350 351
		return lux_val;
	}
352

353 354
	gain_trim_val = (unsigned int)(((chip->als_settings.als_cal_target)
			* chip->als_settings.als_gain_trim) / lux_val);
355
	if ((gain_trim_val < 250) || (gain_trim_val > 4000)) {
356
		dev_err(&chip->client->dev,
357 358
			"%s: trim_val of %d is not within the range [250, 4000]\n",
			__func__, gain_trim_val);
359 360
		return -ENODATA;
	}
361

362
	chip->als_settings.als_gain_trim = (int)gain_trim_val;
363

364
	return 0;
365 366
}

367 368 369 370 371 372
static int tsl2583_set_als_time(struct tsl2583_chip *chip)
{
	int als_count, als_time, ret;
	u8 val;

	/* determine als integration register */
373
	als_count = (chip->als_settings.als_time * 100 + 135) / 270;
374 375 376 377 378 379 380 381
	if (!als_count)
		als_count = 1; /* ensure at least one cycle */

	/* convert back to time (encompasses overrides) */
	als_time = (als_count * 27 + 5) / 10;

	val = 256 - als_count;
	ret = i2c_smbus_write_byte_data(chip->client,
382
					TSL2583_CMD_REG | TSL2583_ALS_TIME,
383 384
					val);
	if (ret < 0) {
385
		dev_err(&chip->client->dev, "%s: failed to set the als time to %d\n",
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
			__func__, val);
		return ret;
	}

	/* set chip struct re scaling and saturation */
	chip->als_saturation = als_count * 922; /* 90% of full scale */
	chip->als_time_scale = (als_time + 25) / 50;

	return ret;
}

static int tsl2583_set_als_gain(struct tsl2583_chip *chip)
{
	int ret;

401
	/* Set the gain based on als_settings struct */
402
	ret = i2c_smbus_write_byte_data(chip->client,
403 404
					TSL2583_CMD_REG | TSL2583_GAIN,
					chip->als_settings.als_gain);
405
	if (ret < 0)
406 407
		dev_err(&chip->client->dev,
			"%s: failed to set the gain to %d\n", __func__,
408
			chip->als_settings.als_gain);
409 410 411 412

	return ret;
}

413 414 415 416 417
static int tsl2583_set_power_state(struct tsl2583_chip *chip, u8 state)
{
	int ret;

	ret = i2c_smbus_write_byte_data(chip->client,
418
					TSL2583_CMD_REG | TSL2583_CNTRL, state);
419
	if (ret < 0)
420 421 422
		dev_err(&chip->client->dev,
			"%s: failed to set the power state to %d\n", __func__,
			state);
423 424 425 426

	return ret;
}

427 428 429 430
/*
 * Turn the device on.
 * Configuration must be set before calling this function.
 */
431
static int tsl2583_chip_init_and_power_on(struct iio_dev *indio_dev)
432
{
433
	struct tsl2583_chip *chip = iio_priv(indio_dev);
434
	int ret;
435

436
	/* Power on the device; ADC off. */
437
	ret = tsl2583_set_power_state(chip, TSL2583_CNTL_PWR_ON);
438 439 440 441
	if (ret < 0)
		return ret;

	ret = i2c_smbus_write_byte_data(chip->client,
442
					TSL2583_CMD_REG | TSL2583_INTERRUPT,
443 444
					TSL2583_INTERRUPT_DISABLED);
	if (ret < 0) {
445 446
		dev_err(&chip->client->dev,
			"%s: failed to disable interrupts\n", __func__);
447 448 449
		return ret;
	}

450 451
	ret = tsl2583_set_als_time(chip);
	if (ret < 0)
452
		return ret;
453

454 455
	ret = tsl2583_set_als_gain(chip);
	if (ret < 0)
456
		return ret;
457

458
	usleep_range(3000, 3500);
459

460 461
	ret = tsl2583_set_power_state(chip, TSL2583_CNTL_PWR_ON |
					    TSL2583_CNTL_ADC_ENBL);
462
	if (ret < 0)
463
		return ret;
464

465 466 467 468 469
	return ret;
}

/* Sysfs Interface Functions */

470 471 472
static ssize_t in_illuminance_input_target_show(struct device *dev,
						struct device_attribute *attr,
						char *buf)
473
{
474
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
475
	struct tsl2583_chip *chip = iio_priv(indio_dev);
476 477 478
	int ret;

	mutex_lock(&chip->als_mutex);
479
	ret = sprintf(buf, "%d\n", chip->als_settings.als_cal_target);
480
	mutex_unlock(&chip->als_mutex);
481

482
	return ret;
483 484
}

485 486 487
static ssize_t in_illuminance_input_target_store(struct device *dev,
						 struct device_attribute *attr,
						 const char *buf, size_t len)
488
{
489
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
490
	struct tsl2583_chip *chip = iio_priv(indio_dev);
491
	int value;
492

493
	if (kstrtoint(buf, 0, &value) || !value)
494 495
		return -EINVAL;

496
	mutex_lock(&chip->als_mutex);
497
	chip->als_settings.als_cal_target = value;
498
	mutex_unlock(&chip->als_mutex);
499 500 501 502

	return len;
}

503 504 505
static ssize_t in_illuminance_calibrate_store(struct device *dev,
					      struct device_attribute *attr,
					      const char *buf, size_t len)
506
{
507
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
508
	struct tsl2583_chip *chip = iio_priv(indio_dev);
509
	int value, ret;
510

511
	if (kstrtoint(buf, 0, &value) || value != 1)
512 513
		return -EINVAL;

514
	mutex_lock(&chip->als_mutex);
515

516
	ret = tsl2583_als_calibrate(indio_dev);
517 518 519 520 521
	if (ret < 0)
		goto done;

	ret = len;
done:
522
	mutex_unlock(&chip->als_mutex);
523

524
	return ret;
525 526
}

527 528 529
static ssize_t in_illuminance_lux_table_show(struct device *dev,
					     struct device_attribute *attr,
					     char *buf)
530
{
531 532
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
	struct tsl2583_chip *chip = iio_priv(indio_dev);
533
	unsigned int i;
534 535
	int offset = 0;

536
	for (i = 0; i < ARRAY_SIZE(chip->als_settings.als_device_lux); i++) {
537
		offset += sprintf(buf + offset, "%u,%u,%u,",
538 539 540 541
				  chip->als_settings.als_device_lux[i].ratio,
				  chip->als_settings.als_device_lux[i].ch0,
				  chip->als_settings.als_device_lux[i].ch1);
		if (chip->als_settings.als_device_lux[i].ratio == 0) {
542 543 544 545
			/*
			 * We just printed the first "0" entry.
			 * Now get rid of the extra "," and break.
			 */
546 547 548 549 550 551
			offset--;
			break;
		}
	}

	offset += sprintf(buf + offset, "\n");
552

553 554 555
	return offset;
}

556 557 558
static ssize_t in_illuminance_lux_table_store(struct device *dev,
					      struct device_attribute *attr,
					      const char *buf, size_t len)
559
{
560
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
561
	struct tsl2583_chip *chip = iio_priv(indio_dev);
562
	const unsigned int max_ints = TSL2583_MAX_LUX_TABLE_ENTRIES * 3;
563
	int value[TSL2583_MAX_LUX_TABLE_ENTRIES * 3 + 1];
564 565
	int ret = -EINVAL;
	unsigned int n;
566

567 568
	mutex_lock(&chip->als_mutex);

569 570
	get_options(buf, ARRAY_SIZE(value), value);

571 572
	/*
	 * We now have an array of ints starting at value[1], and
573 574 575 576 577
	 * enumerated by value[0].
	 * We expect each group of three ints is one table entry,
	 * and the last table entry is all 0.
	 */
	n = value[0];
578
	if ((n % 3) || n < 6 || n > max_ints) {
579
		dev_err(dev,
580 581
			"%s: The number of entries in the lux table must be a multiple of 3 and within the range [6, %d]\n",
			__func__, max_ints);
582
		goto done;
583
	}
584
	if ((value[n - 2] | value[n - 1] | value[n]) != 0) {
585 586
		dev_err(dev, "%s: The last 3 entries in the lux table must be zeros.\n",
			__func__);
587
		goto done;
588 589
	}

590 591
	memcpy(chip->als_settings.als_device_lux, &value[1],
	       value[0] * sizeof(value[1]));
592

593 594 595
	ret = len;

done:
596 597
	mutex_unlock(&chip->als_mutex);

598
	return ret;
599 600
}

601 602 603 604 605 606
static IIO_CONST_ATTR(in_illuminance_calibscale_available, "1 8 16 111");
static IIO_CONST_ATTR(in_illuminance_integration_time_available,
		      "0.000050 0.000100 0.000150 0.000200 0.000250 0.000300 0.000350 0.000400 0.000450 0.000500 0.000550 0.000600 0.000650");
static IIO_DEVICE_ATTR_RW(in_illuminance_input_target, 0);
static IIO_DEVICE_ATTR_WO(in_illuminance_calibrate, 0);
static IIO_DEVICE_ATTR_RW(in_illuminance_lux_table, 0);
607 608

static struct attribute *sysfs_attrs_ctrl[] = {
609 610 611 612 613
	&iio_const_attr_in_illuminance_calibscale_available.dev_attr.attr,
	&iio_const_attr_in_illuminance_integration_time_available.dev_attr.attr,
	&iio_dev_attr_in_illuminance_input_target.dev_attr.attr,
	&iio_dev_attr_in_illuminance_calibrate.dev_attr.attr,
	&iio_dev_attr_in_illuminance_lux_table.dev_attr.attr,
614 615 616
	NULL
};

617
static const struct attribute_group tsl2583_attribute_group = {
618 619 620
	.attrs = sysfs_attrs_ctrl,
};

621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
static const struct iio_chan_spec tsl2583_channels[] = {
	{
		.type = IIO_LIGHT,
		.modified = 1,
		.channel2 = IIO_MOD_LIGHT_IR,
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	},
	{
		.type = IIO_LIGHT,
		.modified = 1,
		.channel2 = IIO_MOD_LIGHT_BOTH,
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
	},
	{
		.type = IIO_LIGHT,
		.info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED) |
				      BIT(IIO_CHAN_INFO_CALIBBIAS) |
638
				      BIT(IIO_CHAN_INFO_CALIBSCALE) |
639 640 641 642
				      BIT(IIO_CHAN_INFO_INT_TIME),
	},
};

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
static int tsl2583_set_pm_runtime_busy(struct tsl2583_chip *chip, bool on)
{
	int ret;

	if (on) {
		ret = pm_runtime_get_sync(&chip->client->dev);
		if (ret < 0)
			pm_runtime_put_noidle(&chip->client->dev);
	} else {
		pm_runtime_mark_last_busy(&chip->client->dev);
		ret = pm_runtime_put_autosuspend(&chip->client->dev);
	}

	return ret;
}

659 660 661 662 663
static int tsl2583_read_raw(struct iio_dev *indio_dev,
			    struct iio_chan_spec const *chan,
			    int *val, int *val2, long mask)
{
	struct tsl2583_chip *chip = iio_priv(indio_dev);
664
	int ret, pm_ret;
665

666 667 668
	ret = tsl2583_set_pm_runtime_busy(chip, true);
	if (ret < 0)
		return ret;
669

670
	mutex_lock(&chip->als_mutex);
671

672
	ret = -EINVAL;
673 674 675
	switch (mask) {
	case IIO_CHAN_INFO_RAW:
		if (chan->type == IIO_LIGHT) {
676
			ret = tsl2583_get_lux(indio_dev);
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
			if (ret < 0)
				goto read_done;

			/*
			 * From page 20 of the TSL2581, TSL2583 data
			 * sheet (TAOS134 − MARCH 2011):
			 *
			 * One of the photodiodes (channel 0) is
			 * sensitive to both visible and infrared light,
			 * while the second photodiode (channel 1) is
			 * sensitive primarily to infrared light.
			 */
			if (chan->channel2 == IIO_MOD_LIGHT_BOTH)
				*val = chip->als_cur_info.als_ch0;
			else
				*val = chip->als_cur_info.als_ch1;

			ret = IIO_VAL_INT;
		}
		break;
	case IIO_CHAN_INFO_PROCESSED:
		if (chan->type == IIO_LIGHT) {
699
			ret = tsl2583_get_lux(indio_dev);
700 701 702 703 704 705 706 707 708
			if (ret < 0)
				goto read_done;

			*val = ret;
			ret = IIO_VAL_INT;
		}
		break;
	case IIO_CHAN_INFO_CALIBBIAS:
		if (chan->type == IIO_LIGHT) {
709
			*val = chip->als_settings.als_gain_trim;
710 711 712
			ret = IIO_VAL_INT;
		}
		break;
713 714
	case IIO_CHAN_INFO_CALIBSCALE:
		if (chan->type == IIO_LIGHT) {
715
			*val = gainadj[chip->als_settings.als_gain].mean;
716 717 718
			ret = IIO_VAL_INT;
		}
		break;
719 720 721
	case IIO_CHAN_INFO_INT_TIME:
		if (chan->type == IIO_LIGHT) {
			*val = 0;
722
			*val2 = chip->als_settings.als_time;
723 724 725 726 727 728 729 730 731 732
			ret = IIO_VAL_INT_PLUS_MICRO;
		}
		break;
	default:
		break;
	}

read_done:
	mutex_unlock(&chip->als_mutex);

733 734 735 736 737 738 739 740 741 742 743 744
	if (ret < 0)
		return ret;

	/*
	 * Preserve the ret variable if the call to
	 * tsl2583_set_pm_runtime_busy() is successful so the reading
	 * (if applicable) is returned to user space.
	 */
	pm_ret = tsl2583_set_pm_runtime_busy(chip, false);
	if (pm_ret < 0)
		return pm_ret;

745 746 747 748 749 750 751 752
	return ret;
}

static int tsl2583_write_raw(struct iio_dev *indio_dev,
			     struct iio_chan_spec const *chan,
			     int val, int val2, long mask)
{
	struct tsl2583_chip *chip = iio_priv(indio_dev);
753
	int ret;
754

755 756 757
	ret = tsl2583_set_pm_runtime_busy(chip, true);
	if (ret < 0)
		return ret;
758

759
	mutex_lock(&chip->als_mutex);
760

761
	ret = -EINVAL;
762 763 764
	switch (mask) {
	case IIO_CHAN_INFO_CALIBBIAS:
		if (chan->type == IIO_LIGHT) {
765
			chip->als_settings.als_gain_trim = val;
766 767 768
			ret = 0;
		}
		break;
769 770
	case IIO_CHAN_INFO_CALIBSCALE:
		if (chan->type == IIO_LIGHT) {
771
			unsigned int i;
772 773 774

			for (i = 0; i < ARRAY_SIZE(gainadj); i++) {
				if (gainadj[i].mean == val) {
775
					chip->als_settings.als_gain = i;
776
					ret = tsl2583_set_als_gain(chip);
777 778 779 780 781
					break;
				}
			}
		}
		break;
782 783 784
	case IIO_CHAN_INFO_INT_TIME:
		if (chan->type == IIO_LIGHT && !val && val2 >= 50 &&
		    val2 <= 650 && !(val2 % 50)) {
785
			chip->als_settings.als_time = val2;
786
			ret = tsl2583_set_als_time(chip);
787 788 789 790 791 792 793 794
		}
		break;
	default:
		break;
	}

	mutex_unlock(&chip->als_mutex);

795 796 797 798 799 800 801
	if (ret < 0)
		return ret;

	ret = tsl2583_set_pm_runtime_busy(chip, false);
	if (ret < 0)
		return ret;

802 803 804
	return ret;
}

805 806 807
static const struct iio_info tsl2583_info = {
	.attrs = &tsl2583_attribute_group,
	.driver_module = THIS_MODULE,
808 809
	.read_raw = tsl2583_read_raw,
	.write_raw = tsl2583_write_raw,
810 811
};

812 813
static int tsl2583_probe(struct i2c_client *clientp,
			 const struct i2c_device_id *idp)
814
{
815
	int ret;
816 817
	struct tsl2583_chip *chip;
	struct iio_dev *indio_dev;
818 819

	if (!i2c_check_functionality(clientp->adapter,
820
				     I2C_FUNC_SMBUS_BYTE_DATA)) {
821 822
		dev_err(&clientp->dev, "%s: i2c smbus byte data functionality is unsupported\n",
			__func__);
823 824 825
		return -EOPNOTSUPP;
	}

826 827 828
	indio_dev = devm_iio_device_alloc(&clientp->dev, sizeof(*chip));
	if (!indio_dev)
		return -ENOMEM;
829

830
	chip = iio_priv(indio_dev);
831
	chip->client = clientp;
832
	i2c_set_clientdata(clientp, indio_dev);
833 834 835

	mutex_init(&chip->als_mutex);

836
	ret = i2c_smbus_read_byte_data(clientp,
837
				       TSL2583_CMD_REG | TSL2583_CHIPID);
838 839
	if (ret < 0) {
		dev_err(&clientp->dev,
840
			"%s: failed to read the chip ID register\n", __func__);
841
		return ret;
842 843
	}

844
	if ((ret & TSL2583_CHIP_ID_MASK) != TSL2583_CHIP_ID) {
845 846
		dev_err(&clientp->dev, "%s: received an unknown chip ID %x\n",
			__func__, ret);
847
		return -EINVAL;
848 849
	}

850
	indio_dev->info = &tsl2583_info;
851 852
	indio_dev->channels = tsl2583_channels;
	indio_dev->num_channels = ARRAY_SIZE(tsl2583_channels);
853 854 855
	indio_dev->dev.parent = &clientp->dev;
	indio_dev->modes = INDIO_DIRECT_MODE;
	indio_dev->name = chip->client->name;
856

857 858 859 860 861
	pm_runtime_enable(&clientp->dev);
	pm_runtime_set_autosuspend_delay(&clientp->dev,
					 TSL2583_POWER_OFF_DELAY_MS);
	pm_runtime_use_autosuspend(&clientp->dev);

862
	ret = devm_iio_device_register(indio_dev->dev.parent, indio_dev);
863
	if (ret) {
864 865
		dev_err(&clientp->dev, "%s: iio registration failed\n",
			__func__);
866
		return ret;
867 868 869
	}

	/* Load up the V2 defaults (these are hard coded defaults for now) */
870
	tsl2583_defaults(chip);
871 872

	dev_info(&clientp->dev, "Light sensor found.\n");
873

874 875 876
	return 0;
}

877 878 879 880 881 882 883 884 885 886 887 888 889 890
static int tsl2583_remove(struct i2c_client *client)
{
	struct iio_dev *indio_dev = i2c_get_clientdata(client);
	struct tsl2583_chip *chip = iio_priv(indio_dev);

	iio_device_unregister(indio_dev);

	pm_runtime_disable(&client->dev);
	pm_runtime_set_suspended(&client->dev);
	pm_runtime_put_noidle(&client->dev);

	return tsl2583_set_power_state(chip, TSL2583_CNTL_PWR_OFF);
}

891
static int __maybe_unused tsl2583_suspend(struct device *dev)
892
{
L
Lars-Peter Clausen 已提交
893
	struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
894
	struct tsl2583_chip *chip = iio_priv(indio_dev);
895
	int ret;
896 897 898

	mutex_lock(&chip->als_mutex);

899
	ret = tsl2583_set_power_state(chip, TSL2583_CNTL_PWR_OFF);
900 901

	mutex_unlock(&chip->als_mutex);
902

903 904 905
	return ret;
}

906
static int __maybe_unused tsl2583_resume(struct device *dev)
907
{
L
Lars-Peter Clausen 已提交
908
	struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
909
	struct tsl2583_chip *chip = iio_priv(indio_dev);
910
	int ret;
911 912 913

	mutex_lock(&chip->als_mutex);

914
	ret = tsl2583_chip_init_and_power_on(indio_dev);
915 916

	mutex_unlock(&chip->als_mutex);
917

918 919 920
	return ret;
}

921 922 923 924 925
static const struct dev_pm_ops tsl2583_pm_ops = {
	SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
				pm_runtime_force_resume)
	SET_RUNTIME_PM_OPS(tsl2583_suspend, tsl2583_resume, NULL)
};
926

927
static struct i2c_device_id tsl2583_idtable[] = {
928 929 930 931 932
	{ "tsl2580", 0 },
	{ "tsl2581", 1 },
	{ "tsl2583", 2 },
	{}
};
933
MODULE_DEVICE_TABLE(i2c, tsl2583_idtable);
934

935
static const struct of_device_id tsl2583_of_match[] = {
936 937 938 939 940
	{ .compatible = "amstaos,tsl2580", },
	{ .compatible = "amstaos,tsl2581", },
	{ .compatible = "amstaos,tsl2583", },
	{ },
};
941
MODULE_DEVICE_TABLE(of, tsl2583_of_match);
942

943
/* Driver definition */
944
static struct i2c_driver tsl2583_driver = {
945 946
	.driver = {
		.name = "tsl2583",
947 948
		.pm = &tsl2583_pm_ops,
		.of_match_table = tsl2583_of_match,
949
	},
950 951
	.id_table = tsl2583_idtable,
	.probe = tsl2583_probe,
952
	.remove = tsl2583_remove,
953
};
954
module_i2c_driver(tsl2583_driver);
955

956 957
MODULE_AUTHOR("J. August Brenner <jbrenner@taosinc.com>");
MODULE_AUTHOR("Brian Masney <masneyb@onstation.org>");
958 959
MODULE_DESCRIPTION("TAOS tsl2583 ambient light sensor driver");
MODULE_LICENSE("GPL");