From patchwork Fri Nov 17 07:45:52 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anshul Dalal X-Patchwork-Id: 13458451 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="l2NdKuzN" Received: from mail-pf1-x42e.google.com (mail-pf1-x42e.google.com [IPv6:2607:f8b0:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 148C2D52; Thu, 16 Nov 2023 23:47:39 -0800 (PST) Received: by mail-pf1-x42e.google.com with SMTP id d2e1a72fcca58-6c396ef9a3dso1571960b3a.1; Thu, 16 Nov 2023 23:47:39 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1700207258; x=1700812058; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=9XZ+bpR+GYXI1dYrwmpsx3LyIpqyeS55MKPy6ULRoi8=; b=l2NdKuzN7wBB10wdu8EJ3WuG4z7/BTHe+fPgDglQS1xmsb0vtBRI/QwfsCQb4yxgKS Ink+haTwcc2vDaR6UMYJqISKG4D2Gymy/PHGWHirIY19i78wRa+fqk+JN51ADxvWF7cx QcQY6uwtz4tPNe2KMHMezNdPpwCX+xjXVwSgKDEUxEvQ+dIbilGqh0X0TrOhdDZxBb14 bzbX2+tTfYXWQ46hJe7eqWe/yREE20AfRQDDGbURkaa9xHi33iXixL8nkfgm35FhoDwv SIYOCI9YkT59Onjkw6S/4RbaLUniuuUdSU6fvU6bEO8TOVMEjhuxApRoiydoKg4IeqJ6 HPnQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700207258; x=1700812058; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=9XZ+bpR+GYXI1dYrwmpsx3LyIpqyeS55MKPy6ULRoi8=; b=thOzrSAA87+3eS91M8ZCY4z5ASqxx1ZbTLxh8fG/DgJ0Du9G+SOf3mENXMinjt8AO9 PKqdJCYw5cObX7A30/6qKRyAB8xycyzb9YZwhKhtkMAbA3Z9HmLDAjX2UtVN0MJyhef2 pELXELCIlThZ1PCv+rX8V2SWbxadwQxrobeYtShLF2SFRmPVjKeWr+NV52SEySAqZbLr OxZCyY0y9f6PILsZedny9zU02yldNclSyGf95kitn1jskRBbO2HowoGkfbIrly8xzOz6 64lB/hlU9zD34xcUGtBR1Q/uyxy0DCHFEGdRG4hOWyib6U+suHOg9Y3G6QLbNcAUE/YB sykw== X-Gm-Message-State: AOJu0Yymi9H7ub0MxQtQZvxpaBnkBT09sb6LGTCJqi0x2LnWkAqhY71L Hy37BiZOvMihb1jEjhszlh4mUbf02Ic5+nXN X-Google-Smtp-Source: AGHT+IFwcIo97MOV0GGbVZAt8q3V0mlq6OF09rSEFW131Gzc0pADAo1EAFoUCE8+jHLI+4uS3hImkg== X-Received: by 2002:a05:6a00:140e:b0:6ca:2b55:58b7 with SMTP id l14-20020a056a00140e00b006ca2b5558b7mr7574827pfu.20.1700207257927; Thu, 16 Nov 2023 23:47:37 -0800 (PST) Received: from localhost.localdomain ([2401:4900:2353:8963:b940:1ac0:2fbc:6b6]) by smtp.gmail.com with ESMTPSA id p16-20020a056a000a1000b006b5922221f4sm870110pfh.8.2023.11.16.23.47.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 16 Nov 2023 23:47:37 -0800 (PST) From: Anshul Dalal To: linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org, devicetree@vger.kernel.org Cc: Anshul Dalal , Conor Dooley , Lars-Peter Clausen , Rob Herring , Krzysztof Kozlowski , linux-kernel-mentees@lists.linuxfoundation.org, Jonathan Cameron , Shuah Khan Subject: [PATCH v2 1/2] dt-bindings: iio: light: add ltr390 Date: Fri, 17 Nov 2023 13:15:52 +0530 Message-ID: <20231117074554.700970-1-anshulusr@gmail.com> X-Mailer: git-send-email 2.42.1 Precedence: bulk X-Mailing-List: linux-iio@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Add binding for Lite-On LTR390 which is an Ambient/UV light sensor that communicates over i2c with an address of 0x53. Datasheet: https://optoelectronics.liteon.com/upload/download/DS86-2015-0004/LTR-390UV_Final_%20DS_V1%201.pdf Signed-off-by: Anshul Dalal Reviewed-by: Krzysztof Kozlowski --- Changes for v2: - Added missing properties in the example --- .../bindings/iio/light/liteon,ltr390.yaml | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/light/liteon,ltr390.yaml diff --git a/Documentation/devicetree/bindings/iio/light/liteon,ltr390.yaml b/Documentation/devicetree/bindings/iio/light/liteon,ltr390.yaml new file mode 100644 index 000000000000..5d98ef2af74d --- /dev/null +++ b/Documentation/devicetree/bindings/iio/light/liteon,ltr390.yaml @@ -0,0 +1,56 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/light/liteon,ltr390.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Lite-On LTR390 ALS and UV Sensor + +description: | + The Lite-On LTR390 is an ALS (Ambient Light Sensor) and a UV sensor in a + single package with i2c address of 0x53. + + Datasheet: + https://optoelectronics.liteon.com/upload/download/DS86-2015-0004/LTR-390UV_Final_%20DS_V1%201.pdf + +maintainers: + - Anshul Dalal + +properties: + compatible: + enum: + - liteon,ltr390 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + description: | + Level interrupt pin with open drain output. + The sensor pulls this pin low when the measured reading is greater than + some configured threshold. + + vdd-supply: true + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + #include + + i2c { + #address-cells = <1>; + #size-cells = <0>; + + light-sensor@53 { + compatible = "liteon,ltr390"; + reg = <0x53>; + interrupts = <18 IRQ_TYPE_EDGE_FALLING>; + vdd-supply = <&vdd_regulator>; + }; + }; From patchwork Fri Nov 17 07:45:53 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anshul Dalal X-Patchwork-Id: 13458452 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ZzitRwW3" Received: from mail-pf1-x434.google.com (mail-pf1-x434.google.com [IPv6:2607:f8b0:4864:20::434]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4D162D56; Thu, 16 Nov 2023 23:47:44 -0800 (PST) Received: by mail-pf1-x434.google.com with SMTP id d2e1a72fcca58-6c4cf0aea06so1656092b3a.0; Thu, 16 Nov 2023 23:47:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1700207263; x=1700812063; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=0m7RBqHKFE6z7TEklxK9RLQxemjN8YO2rPkrL7zLXKE=; b=ZzitRwW3ObC1Ruu8otBCSqdKKOZBsG02y2XFkr8xapUxNQUBlSSFNiYo5763z3NIan Pavb4YabKastf9pxFgt30Gdwwhb5aI0rpS6pVkHxb3AWXFPmzYWIiRvLsqgMK2Lo0X7Z XkYzLG0K11fR6xWd3SvDIhAeRQ5JN+YMUdoOZQ2/oJIDRgrUeTlQyXy3bAcrRNGAxk2Y YgYhPUOEfrDfY707ldwiFIyfvboUdy72aFxfG0asa5RmEcxNAwasrR+NZ/1Ca2TgvLeH VQr0z4mcn1IWIAFbWLl11mLO0VPrPOGv67dc/VCz6DoGDdK7G6TDT/4MlJTuSYlNmNNr inow== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700207263; x=1700812063; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=0m7RBqHKFE6z7TEklxK9RLQxemjN8YO2rPkrL7zLXKE=; b=DbnJJW4HWJBbfQKsMl5htErJBYNPrbwH+Dn1qQ5cErPm28EUvbd3DlOoCQ2TMWZa+u cwNj4lIHZYO05T1QGAg5UB8gpas6tAFVpZ7mzvxEAkuf4EgCCowEcmqEV70HM6mXvI74 Nca4zQDmF8+s+WF81CldONS1dVW8lCrkwh4/Yy5JFwqtdRd/tkS30ynI2EwVigcFLJ6u Aupqo3IYjq9WQbpGnfSCv7di760Pv7kmeFmqwsh42Ip+VoRDsF9U3kOnmeLE6hjXDWq6 s6PPnHRikI7KtKD0OseX9k3/2JP60dm7m+PnVP9JuHRnRZYZVuvFWVD8szS4LFEoiUg8 OnTw== X-Gm-Message-State: AOJu0Yz8giHqzKGc8Hde0+4koJGFWhtlgcrVC4Q32incOXpjguIAhZ5/ ieJrJkTn/L8DA3+II5Oer1Ka0ctxo4vLdg== X-Google-Smtp-Source: AGHT+IEGzv68xaKRYz7wo3ZbstXcwHdt9YtpzlYI45oUgjPeUPATYsUGI3A4OxMt0e6gCnRkft2PrA== X-Received: by 2002:a05:6a00:398c:b0:6c3:44e2:3e96 with SMTP id fi12-20020a056a00398c00b006c344e23e96mr20588976pfb.27.1700207263261; Thu, 16 Nov 2023 23:47:43 -0800 (PST) Received: from localhost.localdomain ([2401:4900:2353:8963:b940:1ac0:2fbc:6b6]) by smtp.gmail.com with ESMTPSA id p16-20020a056a000a1000b006b5922221f4sm870110pfh.8.2023.11.16.23.47.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 16 Nov 2023 23:47:41 -0800 (PST) From: Anshul Dalal To: linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org, devicetree@vger.kernel.org Cc: Anshul Dalal , Conor Dooley , Lars-Peter Clausen , Rob Herring , Krzysztof Kozlowski , linux-kernel-mentees@lists.linuxfoundation.org, Jonathan Cameron , Shuah Khan Subject: [PATCH v2 2/2] iio: light: driver for Lite-On ltr390 Date: Fri, 17 Nov 2023 13:15:53 +0530 Message-ID: <20231117074554.700970-2-anshulusr@gmail.com> X-Mailer: git-send-email 2.42.1 In-Reply-To: <20231117074554.700970-1-anshulusr@gmail.com> References: <20231117074554.700970-1-anshulusr@gmail.com> Precedence: bulk X-Mailing-List: linux-iio@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Implements driver for the Ambient/UV Light sensor LTR390. The driver exposes two ways of getting sensor readings: 1. Raw UV Counts directly from the sensor 2. The computed UV Index value with a percision of 2 decimal places NOTE: Ambient light sensing has not been implemented yet. Datasheet: https://optoelectronics.liteon.com/upload/download/DS86-2015-0004/LTR-390UV_Final_%20DS_V1%201.pdf Driver tested on RPi Zero 2W Signed-off-by: Anshul Dalal --- Changes for v2: - Fixed typo in `LTR390_FRACTIONAL_PRECISION` - Added of_device_id --- MAINTAINERS | 7 ++ drivers/iio/light/Kconfig | 11 ++ drivers/iio/light/Makefile | 1 + drivers/iio/light/ltr390.c | 232 +++++++++++++++++++++++++++++++++++++ 4 files changed, 251 insertions(+) create mode 100644 drivers/iio/light/ltr390.c diff --git a/MAINTAINERS b/MAINTAINERS index 81d5fc0bba68..c9f2238673f0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12484,6 +12484,13 @@ S: Maintained W: http://linux-test-project.github.io/ T: git https://github.com/linux-test-project/ltp.git +LTR390 AMBIENT/UV LIGHT SENSOR DRIVER +M: Anshul Dalal +L: linux-iio@vger.kernel.org +S: Maintained +F: Documentation/devicetree/bindings/iio/light/liteon,ltr390.yaml +F: drivers/iio/light/ltr390.c + LYNX 28G SERDES PHY DRIVER M: Ioana Ciornei L: netdev@vger.kernel.org diff --git a/drivers/iio/light/Kconfig b/drivers/iio/light/Kconfig index 45edba797e4c..61993ae79afe 100644 --- a/drivers/iio/light/Kconfig +++ b/drivers/iio/light/Kconfig @@ -347,6 +347,17 @@ config SENSORS_LM3533 changes. The ALS-control output values can be set per zone for the three current output channels. +config LTR390 + tristate "LTR-390UV-01 ambient light and UV sensor" + depends on I2C + select REGMAP_I2C + help + If you say yes here you get support for the Lite-On LTR-390UV-01 + ambient light and UV sensor. + + This driver can also be built as a module. If so, the module + will be called ltr390. + config LTR501 tristate "LTR-501ALS-01 light sensor" depends on I2C diff --git a/drivers/iio/light/Makefile b/drivers/iio/light/Makefile index c0db4c4c36ec..550f8b408bc2 100644 --- a/drivers/iio/light/Makefile +++ b/drivers/iio/light/Makefile @@ -30,6 +30,7 @@ obj-$(CONFIG_SENSORS_ISL29028) += isl29028.o obj-$(CONFIG_ISL29125) += isl29125.o obj-$(CONFIG_JSA1212) += jsa1212.o obj-$(CONFIG_SENSORS_LM3533) += lm3533-als.o +obj-$(CONFIG_LTR390) += ltr390.o obj-$(CONFIG_LTR501) += ltr501.o obj-$(CONFIG_LTRF216A) += ltrf216a.o obj-$(CONFIG_LV0104CS) += lv0104cs.o diff --git a/drivers/iio/light/ltr390.c b/drivers/iio/light/ltr390.c new file mode 100644 index 000000000000..67ca028ce828 --- /dev/null +++ b/drivers/iio/light/ltr390.c @@ -0,0 +1,232 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * IIO driver for Lite-On LTR390 ALS and UV sensor + * (7-bit I2C slave address 0x53) + * + * Based on the work of: + * Shreeya Patel and Shi Zhigang (LTRF216 Driver) + * + * Copyright (C) 2023 Anshul Dalal + * + * Datasheet: + * https://optoelectronics.liteon.com/upload/download/DS86-2015-0004/LTR-390UV_Final_%20DS_V1%201.pdf + * + * TODO: + * - Support for configurable gain and resolution + * - Sensor suspend/resume support + * - Add support for reading the ALS + * - Interrupt support + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#define LTR390_DEVICE_NAME "ltr390" + +#define LTR390_MAIN_CTRL 0x00 +#define LTR390_PART_ID 0x06 +#define LTR390_UVS_DATA 0x10 + +#define LTR390_SW_RESET BIT(4) +#define LTR390_UVS_MODE BIT(3) +#define LTR390_SENSOR_ENABLE BIT(1) + +#define LTR390_PART_NUMBER_ID 0xb +#define LTR390_FRACTIONAL_PERCISION 100 + +/* + * At 20-bit resolution (integration time: 400ms) and 18x gain, 2300 counts of + * the sensor are equal to 1 UV Index [Datasheet Page#8]. + * + * For the default resolution of 18-bit (integration time: 100ms) and default + * gain of 3x, the counts/uvi are calculated as follows: + * 2300 / ((3/18) * (100/400)) = 95.83 + */ +#define LTR390_COUNTS_PER_UVI 96 + +/* + * 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 LTR390_WINDOW_FACTOR 1 + +struct ltr390_data { + struct regmap *regmap; + struct i2c_client *client; + struct mutex lock; +}; + +static const struct regmap_config ltr390_regmap_config = { + .name = LTR390_DEVICE_NAME, + .reg_bits = 8, + .reg_stride = 1, + .val_bits = 8, +}; + +static int ltr390_register_read(struct ltr390_data *data, u8 register_address) +{ + struct device *dev = &data->client->dev; + int ret; + u8 recieve_buffer[3]; + + mutex_lock(&data->lock); + + ret = regmap_bulk_read(data->regmap, register_address, recieve_buffer, + sizeof(recieve_buffer)); + if (ret) { + dev_err(dev, "failed to read measurement data: %d\n", ret); + mutex_unlock(&data->lock); + return ret; + } + + mutex_unlock(&data->lock); + return get_unaligned_le24(recieve_buffer); +} + +static int ltr390_get_uv_index(struct ltr390_data *data) +{ + int ret; + int uv_index; + + ret = ltr390_register_read(data, LTR390_UVS_DATA); + if (ret < 0) + return ret; + + uv_index = DIV_ROUND_CLOSEST(ret * LTR390_FRACTIONAL_PERCISION * + LTR390_WINDOW_FACTOR, + LTR390_COUNTS_PER_UVI); + + return uv_index; +} + +static int ltr390_read_raw(struct iio_dev *iio_device, + struct iio_chan_spec const *chan, int *val, + int *val2, long mask) +{ + int ret; + struct ltr390_data *data = iio_priv(iio_device); + + switch (mask) { + case IIO_CHAN_INFO_PROCESSED: + ret = ltr390_get_uv_index(data); + if (ret < 0) + return ret; + *val = ret; + *val2 = LTR390_FRACTIONAL_PERCISION; + return IIO_VAL_FRACTIONAL; + case IIO_CHAN_INFO_RAW: + ret = ltr390_register_read(data, LTR390_UVS_DATA); + if (ret < 0) + return ret; + *val = ret; + return IIO_VAL_INT; + default: + return -EINVAL; + } +} + +static const struct iio_info ltr390_info = { + .read_raw = ltr390_read_raw, +}; + +static const struct iio_chan_spec ltr390_channels[] = { + { + .type = IIO_UVINDEX, + .info_mask_separate = BIT(IIO_CHAN_INFO_PROCESSED) + }, + { + .type = IIO_INTENSITY, + .channel2 = IIO_MOD_LIGHT_UV, + .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) + }, +}; + +static int ltr390_probe(struct i2c_client *client) +{ + struct ltr390_data *data; + struct iio_dev *indio_dev; + int ret, part_number; + + 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, <r390_regmap_config); + if (IS_ERR(data->regmap)) + return dev_err_probe(&client->dev, PTR_ERR(data->regmap), + "regmap initialization failed\n"); + + data->client = client; + i2c_set_clientdata(client, indio_dev); + mutex_init(&data->lock); + + indio_dev->info = <r390_info; + indio_dev->channels = ltr390_channels; + indio_dev->num_channels = ARRAY_SIZE(ltr390_channels); + indio_dev->name = LTR390_DEVICE_NAME; + + ret = regmap_read(data->regmap, LTR390_PART_ID, &part_number); + if (ret) { + dev_err(&client->dev, "failed to get sensor's part id: %d", + ret); + return ret; + } + /* Lower 4 bits of `part_number` change with hardware revisions */ + if (part_number >> 4 != LTR390_PART_NUMBER_ID) { + dev_err(&client->dev, "received invalid product id: 0x%x", + part_number); + return -ENODEV; + } + dev_dbg(&client->dev, "LTR390, product id: 0x%x\n", part_number); + + /* reset sensor, chip fails to respond to this, so ignore any errors */ + regmap_set_bits(data->regmap, LTR390_MAIN_CTRL, LTR390_SW_RESET); + + /* Wait for the registers to reset before proceeding */ + usleep_range(1000, 2000); + + ret = regmap_set_bits(data->regmap, LTR390_MAIN_CTRL, + LTR390_SENSOR_ENABLE | LTR390_UVS_MODE); + if (ret) { + dev_err(&client->dev, "failed to enable the sensor: %d\n", ret); + return ret; + } + + return devm_iio_device_register(&client->dev, indio_dev); +} + +static const struct i2c_device_id ltr390_id[] = { + { LTR390_DEVICE_NAME, 0 }, + { /* Sentinel */ }, +}; +MODULE_DEVICE_TABLE(i2c, ltr390_id); + +static const struct of_device_id ltr390_of_table[] = { + { .compatible = "liteon,ltr390"}, + { /* Sentinel */ } +}; +MODULE_DEVICE_TABLE(of, ltr390_id_table); + +static struct i2c_driver ltr390_driver = { + .driver = { + .name = LTR390_DEVICE_NAME, + .of_match_table = ltr390_of_table, + }, + .probe = ltr390_probe, + .id_table = ltr390_id, +}; + +module_i2c_driver(ltr390_driver); + +MODULE_AUTHOR("Anshul Dalal "); +MODULE_DESCRIPTION("Lite-On LTR390 ALS and UV sensor Driver"); +MODULE_LICENSE("GPL");