| .. | .. |
|---|
| 1 | +// SPDX-License-Identifier: GPL-2.0-only |
|---|
| 1 | 2 | /* |
|---|
| 2 | 3 | * ccs811.c - Support for AMS CCS811 VOC Sensor |
|---|
| 3 | 4 | * |
|---|
| 4 | 5 | * Copyright (C) 2017 Narcisa Vasile <narcisaanamaria12@gmail.com> |
|---|
| 5 | 6 | * |
|---|
| 6 | 7 | * Datasheet: ams.com/content/download/951091/2269479/CCS811_DS000459_3-00.pdf |
|---|
| 7 | | - * |
|---|
| 8 | | - * This program is free software; you can redistribute it and/or modify |
|---|
| 9 | | - * it under the terms of the GNU General Public License version 2 as |
|---|
| 10 | | - * published by the Free Software Foundation. |
|---|
| 11 | 8 | * |
|---|
| 12 | 9 | * IIO driver for AMS CCS811 (I2C address 0x5A/0x5B set by ADDR Low/High) |
|---|
| 13 | 10 | * |
|---|
| .. | .. |
|---|
| 19 | 16 | */ |
|---|
| 20 | 17 | |
|---|
| 21 | 18 | #include <linux/delay.h> |
|---|
| 19 | +#include <linux/gpio/consumer.h> |
|---|
| 22 | 20 | #include <linux/i2c.h> |
|---|
| 23 | 21 | #include <linux/iio/iio.h> |
|---|
| 24 | 22 | #include <linux/iio/buffer.h> |
|---|
| .. | .. |
|---|
| 39 | 37 | #define CCS811_ERR 0xE0 |
|---|
| 40 | 38 | /* Used to transition from boot to application mode */ |
|---|
| 41 | 39 | #define CCS811_APP_START 0xF4 |
|---|
| 40 | +#define CCS811_SW_RESET 0xFF |
|---|
| 42 | 41 | |
|---|
| 43 | 42 | /* Status register flags */ |
|---|
| 44 | 43 | #define CCS811_STATUS_ERROR BIT(0) |
|---|
| .. | .. |
|---|
| 77 | 76 | struct mutex lock; /* Protect readings */ |
|---|
| 78 | 77 | struct ccs811_reading buffer; |
|---|
| 79 | 78 | struct iio_trigger *drdy_trig; |
|---|
| 79 | + struct gpio_desc *wakeup_gpio; |
|---|
| 80 | 80 | bool drdy_trig_on; |
|---|
| 81 | 81 | /* Ensures correct alignment of timestamp if present */ |
|---|
| 82 | 82 | struct { |
|---|
| .. | .. |
|---|
| 174 | 174 | CCS811_MODE_IAQ_1SEC); |
|---|
| 175 | 175 | } |
|---|
| 176 | 176 | |
|---|
| 177 | +static void ccs811_set_wakeup(struct ccs811_data *data, bool enable) |
|---|
| 178 | +{ |
|---|
| 179 | + if (!data->wakeup_gpio) |
|---|
| 180 | + return; |
|---|
| 181 | + |
|---|
| 182 | + gpiod_set_value(data->wakeup_gpio, enable); |
|---|
| 183 | + |
|---|
| 184 | + if (enable) |
|---|
| 185 | + usleep_range(50, 60); |
|---|
| 186 | + else |
|---|
| 187 | + usleep_range(20, 30); |
|---|
| 188 | +} |
|---|
| 189 | + |
|---|
| 177 | 190 | static int ccs811_get_measurement(struct ccs811_data *data) |
|---|
| 178 | 191 | { |
|---|
| 179 | 192 | int ret, tries = 11; |
|---|
| 193 | + |
|---|
| 194 | + ccs811_set_wakeup(data, true); |
|---|
| 180 | 195 | |
|---|
| 181 | 196 | /* Maximum waiting time: 1s, as measurements are made every second */ |
|---|
| 182 | 197 | while (tries-- > 0) { |
|---|
| .. | .. |
|---|
| 191 | 206 | if (!(ret & CCS811_STATUS_DATA_READY)) |
|---|
| 192 | 207 | return -EIO; |
|---|
| 193 | 208 | |
|---|
| 194 | | - return i2c_smbus_read_i2c_block_data(data->client, |
|---|
| 209 | + ret = i2c_smbus_read_i2c_block_data(data->client, |
|---|
| 195 | 210 | CCS811_ALG_RESULT_DATA, 8, |
|---|
| 196 | 211 | (char *)&data->buffer); |
|---|
| 212 | + ccs811_set_wakeup(data, false); |
|---|
| 213 | + |
|---|
| 214 | + return ret; |
|---|
| 197 | 215 | } |
|---|
| 198 | 216 | |
|---|
| 199 | 217 | static int ccs811_read_raw(struct iio_dev *indio_dev, |
|---|
| .. | .. |
|---|
| 344 | 362 | return IRQ_HANDLED; |
|---|
| 345 | 363 | } |
|---|
| 346 | 364 | |
|---|
| 365 | +static int ccs811_reset(struct i2c_client *client) |
|---|
| 366 | +{ |
|---|
| 367 | + struct gpio_desc *reset_gpio; |
|---|
| 368 | + int ret; |
|---|
| 369 | + |
|---|
| 370 | + reset_gpio = devm_gpiod_get_optional(&client->dev, "reset", |
|---|
| 371 | + GPIOD_OUT_LOW); |
|---|
| 372 | + if (IS_ERR(reset_gpio)) |
|---|
| 373 | + return PTR_ERR(reset_gpio); |
|---|
| 374 | + |
|---|
| 375 | + /* Try to reset using nRESET pin if available else do SW reset */ |
|---|
| 376 | + if (reset_gpio) { |
|---|
| 377 | + gpiod_set_value(reset_gpio, 1); |
|---|
| 378 | + usleep_range(20, 30); |
|---|
| 379 | + gpiod_set_value(reset_gpio, 0); |
|---|
| 380 | + } else { |
|---|
| 381 | + /* |
|---|
| 382 | + * As per the datasheet, this sequence of values needs to be |
|---|
| 383 | + * written to the SW_RESET register for triggering the soft |
|---|
| 384 | + * reset in the device and placing it in boot mode. |
|---|
| 385 | + */ |
|---|
| 386 | + static const u8 reset_seq[] = { |
|---|
| 387 | + 0x11, 0xE5, 0x72, 0x8A, |
|---|
| 388 | + }; |
|---|
| 389 | + |
|---|
| 390 | + ret = i2c_smbus_write_i2c_block_data(client, CCS811_SW_RESET, |
|---|
| 391 | + sizeof(reset_seq), reset_seq); |
|---|
| 392 | + if (ret < 0) { |
|---|
| 393 | + dev_err(&client->dev, "Failed to reset sensor\n"); |
|---|
| 394 | + return ret; |
|---|
| 395 | + } |
|---|
| 396 | + } |
|---|
| 397 | + |
|---|
| 398 | + /* tSTART delay required after reset */ |
|---|
| 399 | + usleep_range(1000, 2000); |
|---|
| 400 | + |
|---|
| 401 | + return 0; |
|---|
| 402 | +} |
|---|
| 403 | + |
|---|
| 347 | 404 | static int ccs811_probe(struct i2c_client *client, |
|---|
| 348 | 405 | const struct i2c_device_id *id) |
|---|
| 349 | 406 | { |
|---|
| .. | .. |
|---|
| 356 | 413 | | I2C_FUNC_SMBUS_READ_I2C_BLOCK)) |
|---|
| 357 | 414 | return -EOPNOTSUPP; |
|---|
| 358 | 415 | |
|---|
| 359 | | - /* Check hardware id (should be 0x81 for this family of devices) */ |
|---|
| 360 | | - ret = i2c_smbus_read_byte_data(client, CCS811_HW_ID); |
|---|
| 361 | | - if (ret < 0) |
|---|
| 362 | | - return ret; |
|---|
| 363 | | - |
|---|
| 364 | | - if (ret != CCS811_HW_ID_VALUE) { |
|---|
| 365 | | - dev_err(&client->dev, "hardware id doesn't match CCS81x\n"); |
|---|
| 366 | | - return -ENODEV; |
|---|
| 367 | | - } |
|---|
| 368 | | - |
|---|
| 369 | | - ret = i2c_smbus_read_byte_data(client, CCS811_HW_VERSION); |
|---|
| 370 | | - if (ret < 0) |
|---|
| 371 | | - return ret; |
|---|
| 372 | | - |
|---|
| 373 | | - if ((ret & CCS811_HW_VERSION_MASK) != CCS811_HW_VERSION_VALUE) { |
|---|
| 374 | | - dev_err(&client->dev, "no CCS811 sensor\n"); |
|---|
| 375 | | - return -ENODEV; |
|---|
| 376 | | - } |
|---|
| 377 | | - |
|---|
| 378 | 416 | indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data)); |
|---|
| 379 | 417 | if (!indio_dev) |
|---|
| 380 | 418 | return -ENOMEM; |
|---|
| 381 | | - |
|---|
| 382 | | - ret = ccs811_setup(client); |
|---|
| 383 | | - if (ret < 0) |
|---|
| 384 | | - return ret; |
|---|
| 385 | 419 | |
|---|
| 386 | 420 | data = iio_priv(indio_dev); |
|---|
| 387 | 421 | i2c_set_clientdata(client, indio_dev); |
|---|
| 388 | 422 | data->client = client; |
|---|
| 389 | 423 | |
|---|
| 424 | + data->wakeup_gpio = devm_gpiod_get_optional(&client->dev, "wakeup", |
|---|
| 425 | + GPIOD_OUT_HIGH); |
|---|
| 426 | + if (IS_ERR(data->wakeup_gpio)) |
|---|
| 427 | + return PTR_ERR(data->wakeup_gpio); |
|---|
| 428 | + |
|---|
| 429 | + ccs811_set_wakeup(data, true); |
|---|
| 430 | + |
|---|
| 431 | + ret = ccs811_reset(client); |
|---|
| 432 | + if (ret) { |
|---|
| 433 | + ccs811_set_wakeup(data, false); |
|---|
| 434 | + return ret; |
|---|
| 435 | + } |
|---|
| 436 | + |
|---|
| 437 | + /* Check hardware id (should be 0x81 for this family of devices) */ |
|---|
| 438 | + ret = i2c_smbus_read_byte_data(client, CCS811_HW_ID); |
|---|
| 439 | + if (ret < 0) { |
|---|
| 440 | + ccs811_set_wakeup(data, false); |
|---|
| 441 | + return ret; |
|---|
| 442 | + } |
|---|
| 443 | + |
|---|
| 444 | + if (ret != CCS811_HW_ID_VALUE) { |
|---|
| 445 | + dev_err(&client->dev, "hardware id doesn't match CCS81x\n"); |
|---|
| 446 | + ccs811_set_wakeup(data, false); |
|---|
| 447 | + return -ENODEV; |
|---|
| 448 | + } |
|---|
| 449 | + |
|---|
| 450 | + ret = i2c_smbus_read_byte_data(client, CCS811_HW_VERSION); |
|---|
| 451 | + if (ret < 0) { |
|---|
| 452 | + ccs811_set_wakeup(data, false); |
|---|
| 453 | + return ret; |
|---|
| 454 | + } |
|---|
| 455 | + |
|---|
| 456 | + if ((ret & CCS811_HW_VERSION_MASK) != CCS811_HW_VERSION_VALUE) { |
|---|
| 457 | + dev_err(&client->dev, "no CCS811 sensor\n"); |
|---|
| 458 | + ccs811_set_wakeup(data, false); |
|---|
| 459 | + return -ENODEV; |
|---|
| 460 | + } |
|---|
| 461 | + |
|---|
| 462 | + ret = ccs811_setup(client); |
|---|
| 463 | + if (ret < 0) { |
|---|
| 464 | + ccs811_set_wakeup(data, false); |
|---|
| 465 | + return ret; |
|---|
| 466 | + } |
|---|
| 467 | + |
|---|
| 468 | + ccs811_set_wakeup(data, false); |
|---|
| 469 | + |
|---|
| 390 | 470 | mutex_init(&data->lock); |
|---|
| 391 | 471 | |
|---|
| 392 | | - indio_dev->dev.parent = &client->dev; |
|---|
| 393 | 472 | indio_dev->name = id->name; |
|---|
| 394 | 473 | indio_dev->info = &ccs811_info; |
|---|
| 395 | 474 | indio_dev->modes = INDIO_DIRECT_MODE; |
|---|
| .. | .. |
|---|
| 421 | 500 | data->drdy_trig->dev.parent = &client->dev; |
|---|
| 422 | 501 | data->drdy_trig->ops = &ccs811_trigger_ops; |
|---|
| 423 | 502 | iio_trigger_set_drvdata(data->drdy_trig, indio_dev); |
|---|
| 424 | | - indio_dev->trig = data->drdy_trig; |
|---|
| 425 | | - iio_trigger_get(indio_dev->trig); |
|---|
| 426 | 503 | ret = iio_trigger_register(data->drdy_trig); |
|---|
| 427 | 504 | if (ret) |
|---|
| 428 | 505 | goto err_poweroff; |
|---|
| 506 | + |
|---|
| 507 | + indio_dev->trig = iio_trigger_get(data->drdy_trig); |
|---|
| 429 | 508 | } |
|---|
| 430 | 509 | |
|---|
| 431 | 510 | ret = iio_triggered_buffer_setup(indio_dev, NULL, |
|---|
| .. | .. |
|---|
| 474 | 553 | }; |
|---|
| 475 | 554 | MODULE_DEVICE_TABLE(i2c, ccs811_id); |
|---|
| 476 | 555 | |
|---|
| 556 | +static const struct of_device_id ccs811_dt_ids[] = { |
|---|
| 557 | + { .compatible = "ams,ccs811" }, |
|---|
| 558 | + { } |
|---|
| 559 | +}; |
|---|
| 560 | +MODULE_DEVICE_TABLE(of, ccs811_dt_ids); |
|---|
| 561 | + |
|---|
| 477 | 562 | static struct i2c_driver ccs811_driver = { |
|---|
| 478 | 563 | .driver = { |
|---|
| 479 | 564 | .name = "ccs811", |
|---|
| 565 | + .of_match_table = ccs811_dt_ids, |
|---|
| 480 | 566 | }, |
|---|
| 481 | 567 | .probe = ccs811_probe, |
|---|
| 482 | 568 | .remove = ccs811_remove, |
|---|