1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
|
// SPDX-License-Identifier: GPL-2.0-only
/*
* LTRF216A Ambient Light Sensor
*
* Copyright (C) 2022 Collabora, Ltd.
* Author: Shreeya Patel <shreeya.patel@collabora.com>
*
* Copyright (C) 2021 Lite-On Technology Corp (Singapore)
* Author: Shi Zhigang <Zhigang.Shi@liteon.com>
*
* IIO driver for LTRF216A (7-bit I2C slave address 0x53).
*/
#include <linux/bitfield.h>
#include <linux/bits.h>
#include <linux/delay.h>
#include <linux/i2c.h>
#include <linux/init.h>
#include <linux/iopoll.h>
#include <linux/mod_devicetable.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/pm.h>
#include <linux/pm_runtime.h>
#include <linux/regmap.h>
#include <linux/iio/iio.h>
#include <asm/unaligned.h>
#define LTRF216A_ALS_RESET_MASK BIT(4)
#define LTRF216A_ALS_DATA_STATUS BIT(3)
#define LTRF216A_ALS_ENABLE_MASK BIT(1)
#define LTRF216A_MAIN_CTRL 0x00
#define LTRF216A_ALS_MEAS_RES 0x04
#define LTRF216A_ALS_GAIN 0x05
#define LTRF216A_PART_ID 0x06
#define LTRF216A_MAIN_STATUS 0x07
#define LTRF216A_ALS_CLEAR_DATA_0 0x0a
#define LTRF216A_ALS_CLEAR_DATA_1 0x0b
#define LTRF216A_ALS_CLEAR_DATA_2 0x0c
#define LTRF216A_ALS_DATA_0 0x0d
#define LTRF216A_ALS_DATA_1 0x0e
#define LTRF216A_ALS_DATA_2 0x0f
#define LTRF216A_INT_CFG 0x19
#define LTRF216A_INT_PST 0x1a
#define LTRF216A_ALS_THRES_UP_0 0x21
#define LTRF216A_ALS_THRES_UP_1 0x22
#define LTRF216A_ALS_THRES_UP_2 0x23
#define LTRF216A_ALS_THRES_LOW_0 0x24
#define LTRF216A_ALS_THRES_LOW_1 0x25
#define LTRF216A_ALS_THRES_LOW_2 0x26
#define LTRF216A_ALS_READ_DATA_DELAY_US 20000
static const int ltrf216a_int_time_available[][2] = {
{ 0, 400000 },
{ 0, 200000 },
{ 0, 100000 },
{ 0, 50000 },
{ 0, 25000 },
};
static const int ltrf216a_int_time_reg[][2] = {
{ 400, 0x03 },
{ 200, 0x13 },
{ 100, 0x22 },
{ 50, 0x31 },
{ 25, 0x40 },
};
/*
* Window Factor is needed when the device is under Window glass
* with coated tinted ink. This is to compensate for the light loss
* due to the lower transmission rate of the window glass and helps
* in calculating lux.
*/
#define LTRF216A_WIN_FAC 1
struct ltrf216a_data {
struct regmap *regmap;
struct i2c_client *client;
u32 int_time;
u16 int_time_fac;
u8 als_gain_fac;
/*
* Protects regmap accesses and makes sure integration time
* remains constant during the measurement of lux.
*/
struct mutex lock;
};
static const struct iio_chan_spec ltrf216a_channels[] = {
{
.type = IIO_LIGHT,
.info_mask_separate =
BIT(IIO_CHAN_INFO_RAW) |
BIT(IIO_CHAN_INFO_PROCESSED) |
BIT(IIO_CHAN_INFO_INT_TIME),
.info_mask_separate_available =
BIT(IIO_CHAN_INFO_INT_TIME),
},
};
static void ltrf216a_reset(struct iio_dev *indio_dev)
{
struct ltrf216a_data *data = iio_priv(indio_dev);
/* reset sensor, chip fails to respond to this, so ignore any errors */
regmap_write(data->regmap, LTRF216A_MAIN_CTRL, LTRF216A_ALS_RESET_MASK);
/* reset time */
usleep_range(1000, 2000);
}
static int ltrf216a_enable(struct iio_dev *indio_dev)
{
struct ltrf216a_data *data = iio_priv(indio_dev);
struct device *dev = &data->client->dev;
int ret;
/* enable sensor */
ret = regmap_set_bits(data->regmap,
LTRF216A_MAIN_CTRL, LTRF216A_ALS_ENABLE_MASK);
if (ret) {
dev_err(dev, "failed to enable sensor: %d\n", ret);
return ret;
}
/* sleep for one integration cycle after enabling the device */
msleep(ltrf216a_int_time_reg[0][0]);
return 0;
}
static int ltrf216a_disable(struct iio_dev *indio_dev)
{
struct ltrf216a_data *data = iio_priv(indio_dev);
struct device *dev = &data->client->dev;
int ret;
ret = regmap_write(data->regmap, LTRF216A_MAIN_CTRL, 0);
if (ret)
dev_err(dev, "failed to disable sensor: %d\n", ret);
return ret;
}
static void ltrf216a_cleanup(void *data)
{
struct iio_dev *indio_dev = data;
ltrf216a_disable(indio_dev);
}
static int ltrf216a_set_int_time(struct ltrf216a_data *data, int itime)
{
struct device *dev = &data->client->dev;
unsigned int i;
u8 reg_val;
int ret;
for (i = 0; i < ARRAY_SIZE(ltrf216a_int_time_available); i++) {
if (ltrf216a_int_time_available[i][1] == itime)
break;
}
if (i == ARRAY_SIZE(ltrf216a_int_time_available))
return -EINVAL;
reg_val = ltrf216a_int_time_reg[i][1];
ret = regmap_write(data->regmap, LTRF216A_ALS_MEAS_RES, reg_val);
if (ret) {
dev_err(dev, "failed to set integration time: %d\n", ret);
return ret;
}
data->int_time_fac = ltrf216a_int_time_reg[i][0];
data->int_time = itime;
return 0;
}
static int ltrf216a_get_int_time(struct ltrf216a_data *data,
int *val, int *val2)
{
*val = 0;
*val2 = data->int_time;
return IIO_VAL_INT_PLUS_MICRO;
}
static int ltrf216a_set_power_state(struct ltrf216a_data *data, bool on)
{
struct device *dev = &data->client->dev;
int ret = 0;
if (on) {
ret = pm_runtime_resume_and_get(dev);
if (ret) {
dev_err(dev, "failed to resume runtime PM: %d\n", ret);
return ret;
}
} else {
pm_runtime_mark_last_busy(dev);
pm_runtime_put_autosuspend(dev);
}
return ret;
}
static int ltrf216a_read_data(struct ltrf216a_data *data, u8 addr)
{
struct device *dev = &data->client->dev;
int ret, val;
u8 buf[3];
ret = regmap_read_poll_timeout(data->regmap, LTRF216A_MAIN_STATUS,
val, val & LTRF216A_ALS_DATA_STATUS,
LTRF216A_ALS_READ_DATA_DELAY_US,
LTRF216A_ALS_READ_DATA_DELAY_US * 50);
if (ret) {
dev_err(dev, "failed to wait for measurement data: %d\n", ret);
return ret;
}
ret = regmap_bulk_read(data->regmap, addr, buf, sizeof(buf));
if (ret) {
dev_err(dev, "failed to read measurement data: %d\n", ret);
return ret;
}
return get_unaligned_le24(&buf[0]);
}
static int ltrf216a_get_lux(struct ltrf216a_data *data)
{
int ret, greendata;
u64 lux, div;
ret = ltrf216a_set_power_state(data, true);
if (ret)
return ret;
greendata = ltrf216a_read_data(data, LTRF216A_ALS_DATA_0);
if (greendata < 0)
return greendata;
ltrf216a_set_power_state(data, false);
lux = greendata * 45 * LTRF216A_WIN_FAC * 100;
div = data->als_gain_fac * data->int_time_fac * 100;
return div_u64(lux, div);
}
static int ltrf216a_read_raw(struct iio_dev *indio_dev,
struct iio_chan_spec const *chan, int *val,
int *val2, long mask)
{
struct ltrf216a_data *data = iio_priv(indio_dev);
int ret;
switch (mask) {
case IIO_CHAN_INFO_RAW:
ret = ltrf216a_set_power_state(data, true);
if (ret)
return ret;
mutex_lock(&data->lock);
ret = ltrf216a_read_data(data, LTRF216A_ALS_DATA_0);
mutex_unlock(&data->lock);
ltrf216a_set_power_state(data, false);
if (ret < 0)
return ret;
*val = ret;
return IIO_VAL_INT;
case IIO_CHAN_INFO_PROCESSED:
mutex_lock(&data->lock);
ret = ltrf216a_get_lux(data);
mutex_unlock(&data->lock);
if (ret < 0)
return ret;
*val = ret;
return IIO_VAL_INT;
case IIO_CHAN_INFO_INT_TIME:
mutex_lock(&data->lock);
ret = ltrf216a_get_int_time(data, val, val2);
mutex_unlock(&data->lock);
return ret;
default:
return -EINVAL;
}
}
static int ltrf216a_write_raw(struct iio_dev *indio_dev,
struct iio_chan_spec const *chan, int val,
int val2, long mask)
{
struct ltrf216a_data *data = iio_priv(indio_dev);
int ret;
switch (mask) {
case IIO_CHAN_INFO_INT_TIME:
if (val != 0)
return -EINVAL;
mutex_lock(&data->lock);
ret = ltrf216a_set_int_time(data, val2);
mutex_unlock(&data->lock);
return ret;
default:
return -EINVAL;
}
}
static int ltrf216a_read_available(struct iio_dev *indio_dev,
struct iio_chan_spec const *chan,
const int **vals, int *type, int *length,
long mask)
{
switch (mask) {
case IIO_CHAN_INFO_INT_TIME:
*length = ARRAY_SIZE(ltrf216a_int_time_available) * 2;
*vals = (const int *)ltrf216a_int_time_available;
*type = IIO_VAL_INT_PLUS_MICRO;
return IIO_AVAIL_LIST;
default:
return -EINVAL;
}
}
static const struct iio_info ltrf216a_info = {
.read_raw = ltrf216a_read_raw,
.write_raw = ltrf216a_write_raw,
.read_avail = ltrf216a_read_available,
};
static bool ltrf216a_readable_reg(struct device *dev, unsigned int reg)
{
switch (reg) {
case LTRF216A_MAIN_CTRL:
case LTRF216A_ALS_MEAS_RES:
case LTRF216A_ALS_GAIN:
case LTRF216A_PART_ID:
case LTRF216A_MAIN_STATUS:
case LTRF216A_ALS_CLEAR_DATA_0:
case LTRF216A_ALS_CLEAR_DATA_1:
case LTRF216A_ALS_CLEAR_DATA_2:
case LTRF216A_ALS_DATA_0:
case LTRF216A_ALS_DATA_1:
case LTRF216A_ALS_DATA_2:
case LTRF216A_INT_CFG:
case LTRF216A_INT_PST:
case LTRF216A_ALS_THRES_UP_0:
case LTRF216A_ALS_THRES_UP_1:
case LTRF216A_ALS_THRES_UP_2:
case LTRF216A_ALS_THRES_LOW_0:
case LTRF216A_ALS_THRES_LOW_1:
case LTRF216A_ALS_THRES_LOW_2:
return true;
default:
return false;
}
}
static bool ltrf216a_writable_reg(struct device *dev, unsigned int reg)
{
switch (reg) {
case LTRF216A_MAIN_CTRL:
case LTRF216A_ALS_MEAS_RES:
case LTRF216A_ALS_GAIN:
case LTRF216A_INT_CFG:
case LTRF216A_INT_PST:
case LTRF216A_ALS_THRES_UP_0:
case LTRF216A_ALS_THRES_UP_1:
case LTRF216A_ALS_THRES_UP_2:
case LTRF216A_ALS_THRES_LOW_0:
case LTRF216A_ALS_THRES_LOW_1:
case LTRF216A_ALS_THRES_LOW_2:
return true;
default:
return false;
}
}
static bool ltrf216a_volatile_reg(struct device *dev, unsigned int reg)
{
switch (reg) {
case LTRF216A_MAIN_STATUS:
case LTRF216A_ALS_CLEAR_DATA_0:
case LTRF216A_ALS_CLEAR_DATA_1:
case LTRF216A_ALS_CLEAR_DATA_2:
case LTRF216A_ALS_DATA_0:
case LTRF216A_ALS_DATA_1:
case LTRF216A_ALS_DATA_2:
return true;
default:
return false;
}
}
static bool ltrf216a_precious_reg(struct device *dev, unsigned int reg)
{
return reg == LTRF216A_MAIN_STATUS;
}
static const struct regmap_config ltrf216a_regmap_config = {
.name = "ltrf216a",
.reg_bits = 8,
.val_bits = 8,
.cache_type = REGCACHE_RBTREE,
.max_register = LTRF216A_ALS_THRES_LOW_2,
.readable_reg = ltrf216a_readable_reg,
.writeable_reg = ltrf216a_writable_reg,
.volatile_reg = ltrf216a_volatile_reg,
.precious_reg = ltrf216a_precious_reg,
.disable_locking = true,
};
static int ltrf216a_probe(struct i2c_client *client)
{
struct ltrf216a_data *data;
struct iio_dev *indio_dev;
int ret;
indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
if (!indio_dev)
return -ENOMEM;
data = iio_priv(indio_dev);
data->regmap = devm_regmap_init_i2c(client, <rf216a_regmap_config);
if (IS_ERR(data->regmap))
return dev_err_probe(&client->dev, PTR_ERR(data->regmap),
"regmap initialization failed\n");
i2c_set_clientdata(client, indio_dev);
data->client = client;
mutex_init(&data->lock);
indio_dev->info = <rf216a_info;
indio_dev->name = "ltrf216a";
indio_dev->channels = ltrf216a_channels;
indio_dev->num_channels = ARRAY_SIZE(ltrf216a_channels);
indio_dev->modes = INDIO_DIRECT_MODE;
ret = pm_runtime_set_active(&client->dev);
if (ret)
return ret;
/* reset sensor, chip fails to respond to this, so ignore any errors */
ltrf216a_reset(indio_dev);
ret = regmap_reinit_cache(data->regmap, <rf216a_regmap_config);
if (ret)
return dev_err_probe(&client->dev, ret,
"failed to reinit regmap cache\n");
ret = ltrf216a_enable(indio_dev);
if (ret)
return ret;
ret = devm_add_action_or_reset(&client->dev, ltrf216a_cleanup,
indio_dev);
if (ret)
return ret;
ret = devm_pm_runtime_enable(&client->dev);
if (ret)
return dev_err_probe(&client->dev, ret,
"failed to enable runtime PM\n");
pm_runtime_set_autosuspend_delay(&client->dev, 1000);
pm_runtime_use_autosuspend(&client->dev);
data->int_time = 100000;
data->int_time_fac = 100;
data->als_gain_fac = 3;
return devm_iio_device_register(&client->dev, indio_dev);
}
static int ltrf216a_runtime_suspend(struct device *dev)
{
struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
struct ltrf216a_data *data = iio_priv(indio_dev);
int ret;
ret = ltrf216a_disable(indio_dev);
if (ret)
return ret;
regcache_cache_only(data->regmap, true);
return 0;
}
static int ltrf216a_runtime_resume(struct device *dev)
{
struct iio_dev *indio_dev = i2c_get_clientdata(to_i2c_client(dev));
struct ltrf216a_data *data = iio_priv(indio_dev);
int ret;
regcache_cache_only(data->regmap, false);
regcache_mark_dirty(data->regmap);
ret = regcache_sync(data->regmap);
if (ret)
goto cache_only;
ret = ltrf216a_enable(indio_dev);
if (ret)
goto cache_only;
return 0;
cache_only:
regcache_cache_only(data->regmap, true);
return ret;
}
static DEFINE_RUNTIME_DEV_PM_OPS(ltrf216a_pm_ops, ltrf216a_runtime_suspend,
ltrf216a_runtime_resume, NULL);
static const struct i2c_device_id ltrf216a_id[] = {
{ "ltrf216a" },
{}
};
MODULE_DEVICE_TABLE(i2c, ltrf216a_id);
static const struct of_device_id ltrf216a_of_match[] = {
{ .compatible = "liteon,ltrf216a" },
{ .compatible = "ltr,ltrf216a" },
{}
};
MODULE_DEVICE_TABLE(of, ltrf216a_of_match);
static struct i2c_driver ltrf216a_driver = {
.driver = {
.name = "ltrf216a",
.pm = pm_ptr(<rf216a_pm_ops),
.of_match_table = ltrf216a_of_match,
},
.probe_new = ltrf216a_probe,
.id_table = ltrf216a_id,
};
module_i2c_driver(ltrf216a_driver);
MODULE_AUTHOR("Shreeya Patel <shreeya.patel@collabora.com>");
MODULE_AUTHOR("Shi Zhigang <Zhigang.Shi@liteon.com>");
MODULE_DESCRIPTION("LTRF216A ambient light sensor driver");
MODULE_LICENSE("GPL");
|