// SPDX-License-Identifier: GPL-2.0 /* * ScioSense ENS160 multi-gas sensor driver * * Copyright (c) 2024 Gustavo Silva * * Datasheet: * https://www.sciosense.com/wp-content/uploads/2023/12/ENS160-Datasheet.pdf */ #include #include #include #include #include #include #include #include "ens160.h" #define ENS160_PART_ID 0x160 #define ENS160_BOOTING_TIME_MS 10U #define ENS160_REG_PART_ID 0x00 #define ENS160_REG_OPMODE 0x10 #define ENS160_REG_CONFIG 0x11 #define ENS160_REG_CONFIG_INTEN BIT(0) #define ENS160_REG_CONFIG_INTDAT BIT(1) #define ENS160_REG_CONFIG_INT_CFG BIT(5) #define ENS160_REG_MODE_DEEP_SLEEP 0x00 #define ENS160_REG_MODE_IDLE 0x01 #define ENS160_REG_MODE_STANDARD 0x02 #define ENS160_REG_MODE_RESET 0xF0 #define ENS160_REG_COMMAND 0x12 #define ENS160_REG_COMMAND_GET_APPVER 0x0E #define ENS160_REG_COMMAND_CLRGPR 0xCC #define ENS160_REG_TEMP_IN 0x13 #define ENS160_REG_RH_IN 0x15 #define ENS160_REG_DEVICE_STATUS 0x20 #define ENS160_REG_DATA_AQI 0x21 #define ENS160_REG_DATA_TVOC 0x22 #define ENS160_REG_DATA_ECO2 0x24 #define ENS160_REG_DATA_T 0x30 #define ENS160_REG_DATA_RH 0x32 #define ENS160_REG_GPR_READ4 0x4C #define ENS160_STATUS_VALIDITY_FLAG GENMASK(3, 2) #define ENS160_STATUS_NORMAL 0x00 struct ens160_data { struct regmap *regmap; /* Protect reads from the sensor */ struct mutex mutex; struct { __le16 chans[2]; s64 timestamp __aligned(8); } scan __aligned(IIO_DMA_MINALIGN); u8 fw_version[3]; __le16 buf; }; static const struct iio_chan_spec ens160_channels[] = { { .type = IIO_CONCENTRATION, .channel2 = IIO_MOD_VOC, .modified = 1, .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE), .address = ENS160_REG_DATA_TVOC, .scan_index = 0, .scan_type = { .sign = 'u', .realbits = 16, .storagebits = 16, .endianness = IIO_LE, }, }, { .type = IIO_CONCENTRATION, .channel2 = IIO_MOD_CO2, .modified = 1, .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE), .address = ENS160_REG_DATA_ECO2, .scan_index = 1, .scan_type = { .sign = 'u', .realbits = 16, .storagebits = 16, .endianness = IIO_LE, }, }, IIO_CHAN_SOFT_TIMESTAMP(2), }; static int ens160_read_raw(struct iio_dev *indio_dev, struct iio_chan_spec const *chan, int *val, int *val2, long mask) { struct ens160_data *data = iio_priv(indio_dev); int ret; switch (mask) { case IIO_CHAN_INFO_RAW: iio_device_claim_direct_scoped(return -EBUSY, indio_dev) { guard(mutex)(&data->mutex); ret = regmap_bulk_read(data->regmap, chan->address, &data->buf, sizeof(data->buf)); if (ret) return ret; *val = le16_to_cpu(data->buf); return IIO_VAL_INT; } unreachable(); case IIO_CHAN_INFO_SCALE: switch (chan->channel2) { case IIO_MOD_CO2: /* The sensor reads CO2 data as ppm */ *val = 0; *val2 = 100; return IIO_VAL_INT_PLUS_MICRO; case IIO_MOD_VOC: /* The sensor reads VOC data as ppb */ *val = 0; *val2 = 100; return IIO_VAL_INT_PLUS_NANO; default: return -EINVAL; } default: return -EINVAL; } } static int ens160_set_mode(struct ens160_data *data, u8 mode) { int ret; ret = regmap_write(data->regmap, ENS160_REG_OPMODE, mode); if (ret) return ret; msleep(ENS160_BOOTING_TIME_MS); return 0; } static void ens160_set_idle(void *data) { ens160_set_mode(data, ENS160_REG_MODE_IDLE); } static int ens160_chip_init(struct ens160_data *data) { struct device *dev = regmap_get_device(data->regmap); unsigned int status; int ret; ret = ens160_set_mode(data, ENS160_REG_MODE_RESET); if (ret) return ret; ret = regmap_bulk_read(data->regmap, ENS160_REG_PART_ID, &data->buf, sizeof(data->buf)); if (ret) return ret; if (le16_to_cpu(data->buf) != ENS160_PART_ID) return -ENODEV; ret = ens160_set_mode(data, ENS160_REG_MODE_IDLE); if (ret) return ret; ret = regmap_write(data->regmap, ENS160_REG_COMMAND, ENS160_REG_COMMAND_CLRGPR); if (ret) return ret; ret = regmap_write(data->regmap, ENS160_REG_COMMAND, ENS160_REG_COMMAND_GET_APPVER); if (ret) return ret; ret = regmap_bulk_read(data->regmap, ENS160_REG_GPR_READ4, data->fw_version, sizeof(data->fw_version)); if (ret) return ret; dev_info(dev, "firmware version: %u.%u.%u\n", data->fw_version[2], data->fw_version[1], data->fw_version[0]); ret = ens160_set_mode(data, ENS160_REG_MODE_STANDARD); if (ret) return ret; ret = devm_add_action_or_reset(dev, ens160_set_idle, data); if (ret) return ret; ret = regmap_read(data->regmap, ENS160_REG_DEVICE_STATUS, &status); if (ret) return ret; if (FIELD_GET(ENS160_STATUS_VALIDITY_FLAG, status) != ENS160_STATUS_NORMAL) return -EINVAL; return 0; } static const struct iio_info ens160_info = { .read_raw = ens160_read_raw, }; static int ens160_suspend(struct device *dev) { struct iio_dev *indio_dev = dev_get_drvdata(dev); struct ens160_data *data = iio_priv(indio_dev); return ens160_set_mode(data, ENS160_REG_MODE_DEEP_SLEEP); } static int ens160_resume(struct device *dev) { struct iio_dev *indio_dev = dev_get_drvdata(dev); struct ens160_data *data = iio_priv(indio_dev); int ret; ret = ens160_set_mode(data, ENS160_REG_MODE_IDLE); if (ret) return ret; return ens160_set_mode(data, ENS160_REG_MODE_STANDARD); } EXPORT_NS_SIMPLE_DEV_PM_OPS(ens160_pm_ops, ens160_suspend, ens160_resume, IIO_ENS160); static irqreturn_t ens160_trigger_handler(int irq, void *p) { struct iio_poll_func *pf = p; struct iio_dev *indio_dev = pf->indio_dev; struct ens160_data *data = iio_priv(indio_dev); int ret; guard(mutex)(&data->mutex); ret = regmap_bulk_read(data->regmap, ENS160_REG_DATA_TVOC, data->scan.chans, sizeof(data->scan.chans)); if (ret) goto err; iio_push_to_buffers_with_timestamp(indio_dev, &data->scan, pf->timestamp); err: iio_trigger_notify_done(indio_dev->trig); return IRQ_HANDLED; } static int ens160_set_trigger_state(struct iio_trigger *trig, bool state) { struct iio_dev *indio_dev = iio_trigger_get_drvdata(trig); struct ens160_data *data = iio_priv(indio_dev); unsigned int int_bits = ENS160_REG_CONFIG_INTEN | ENS160_REG_CONFIG_INTDAT | ENS160_REG_CONFIG_INT_CFG; if (state) return regmap_set_bits(data->regmap, ENS160_REG_CONFIG, int_bits); else return regmap_clear_bits(data->regmap, ENS160_REG_CONFIG, int_bits); } static const struct iio_trigger_ops ens160_trigger_ops = { .set_trigger_state = ens160_set_trigger_state, .validate_device = iio_trigger_validate_own_device, }; static int ens160_setup_trigger(struct iio_dev *indio_dev, int irq) { struct device *dev = indio_dev->dev.parent; struct iio_trigger *trig; int ret; trig = devm_iio_trigger_alloc(dev, "%s-dev%d", indio_dev->name, iio_device_id(indio_dev)); if (!trig) return dev_err_probe(dev, -ENOMEM, "failed to allocate trigger\n"); trig->ops = &ens160_trigger_ops; iio_trigger_set_drvdata(trig, indio_dev); ret = devm_iio_trigger_register(dev, trig); if (ret) return ret; indio_dev->trig = iio_trigger_get(trig); ret = devm_request_threaded_irq(dev, irq, iio_trigger_generic_data_rdy_poll, NULL, IRQF_ONESHOT, indio_dev->name, indio_dev->trig); if (ret) return dev_err_probe(dev, ret, "failed to request irq\n"); return 0; } int devm_ens160_core_probe(struct device *dev, struct regmap *regmap, int irq, const char *name) { struct ens160_data *data; struct iio_dev *indio_dev; int ret; indio_dev = devm_iio_device_alloc(dev, sizeof(*data)); if (!indio_dev) return -ENOMEM; data = iio_priv(indio_dev); data->regmap = regmap; indio_dev->name = name; indio_dev->info = &ens160_info; indio_dev->modes = INDIO_DIRECT_MODE; indio_dev->channels = ens160_channels; indio_dev->num_channels = ARRAY_SIZE(ens160_channels); if (irq > 0) { ret = ens160_setup_trigger(indio_dev, irq); if (ret) return dev_err_probe(dev, ret, "failed to setup trigger\n"); } ret = ens160_chip_init(data); if (ret) return dev_err_probe(dev, ret, "chip initialization failed\n"); mutex_init(&data->mutex); ret = devm_iio_triggered_buffer_setup(dev, indio_dev, iio_pollfunc_store_time, ens160_trigger_handler, NULL); if (ret) return ret; return devm_iio_device_register(dev, indio_dev); } EXPORT_SYMBOL_NS(devm_ens160_core_probe, IIO_ENS160); MODULE_AUTHOR("Gustavo Silva "); MODULE_DESCRIPTION("ScioSense ENS160 driver"); MODULE_LICENSE("GPL v2");