From patchwork Wed Nov 15 12:58:06 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anshul Dalal X-Patchwork-Id: 744116 Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CAF08179AC; Wed, 15 Nov 2023 13:00:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ibN7e/0C" Received: from mail-oa1-x34.google.com (mail-oa1-x34.google.com [IPv6:2001:4860:4864:20::34]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A6F0F109; Wed, 15 Nov 2023 05:00:15 -0800 (PST) Received: by mail-oa1-x34.google.com with SMTP id 586e51a60fabf-1e9bb3a0bfeso4176835fac.3; Wed, 15 Nov 2023 05:00:15 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1700053214; x=1700658014; 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=wDT3a72/4EK2RXUg+bwJp3dxgNq1+ZbWNBolGSQCq8U=; b=ibN7e/0CnUF46/PfOZy6paIxeUlRCoWjZy9wlCAzkiWJDrWEl5VV87vMjXEDwdHPV/ WxRyTBoIRuhyBbg58gGx5BObPvCo/w1Ey/jdolGlTjhcrLrqMDQab+N9Wgt/rJbbIcYW jhRg7k78zvNBCC7TMmAd8pKfXD3xZYIT4iDBK/LeBTWkfTlnTJC3biId/NBztVIWQRuE UClg2IXW2piS6KEtdf8Kta1lWZaOR8ILYbiBdwf4qUq9/tu3uKS6ywg0rvmRdrYCKK5l YsZZR45PCKKoOBoxfbAPr6wM1a78c+1xfEuS91jkwBg/vUcuV2M2CVjwDANRdPNJauYt JqBA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700053214; x=1700658014; 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=wDT3a72/4EK2RXUg+bwJp3dxgNq1+ZbWNBolGSQCq8U=; b=ESbXCbdhXFj+67y5o440jwxlv18NPnG6W1qUiwpE3LnmuCUM5NDHquLHfT0viyM+WI 7EtcQdT30e3lbnFNbfNXtSqPWQedIG5xWNeOqVlf7rlSYcw73HIctQfAT/bnQGc25gpV d9yaO2qylz3yUUgzIdQBSNM6tPxkeZr2k3YgAU9GC+4uLPXpZFGcIgWzLgukrPuY6FKw zs5UMoGAMt33y7Y8qCcCDy4JkefiU6MNJGZpS4S5+SnVER/kJDGuCCHmbNvuWNEUKTCi LLNwUeGX+AvTBN/W7gmWCw9xMLcfyE0piTXEi1atOttVWdCui0IoB6o6pKu7FGrEJMlw ZtoQ== X-Gm-Message-State: AOJu0YxVB9riD1SBlrfY3xC2lBFcLE0ss7ROBxqpwN36U4tZVohKmuSy 2td2kMSrFCKIQzFvSlofHJpeq5xQBl1x2w== X-Google-Smtp-Source: AGHT+IEPrIUX6ZzViiJXg+HhiZ1aUAYZpbVsJ3LLGoCj+Ba6zvmxvqFqsdgCHXtK315N6GkzpKzK2Q== X-Received: by 2002:a05:6870:f14d:b0:1d5:b2ba:bc93 with SMTP id l13-20020a056870f14d00b001d5b2babc93mr15039104oac.13.1700053203762; Wed, 15 Nov 2023 05:00:03 -0800 (PST) Received: from localhost.localdomain ([2401:4900:2353:8963:b940:1ac0:2fbc:6b6]) by smtp.gmail.com with ESMTPSA id fh42-20020a056a00392a00b006c4d128b71esm2812867pfb.98.2023.11.15.05.00.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Nov 2023 05:00:03 -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 Subject: [PATCH v2 1/3] dt-bindings: vendor-prefixes: add aosong Date: Wed, 15 Nov 2023 18:28:06 +0530 Message-ID: <20231115125810.1394854-1-anshulusr@gmail.com> X-Mailer: git-send-email 2.42.0 Precedence: bulk X-Mailing-List: devicetree@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Aosong Electronic Co., LTD. is a supplier for MEMS sensors such as AHT20 temperature and humidity sensor under the brand name Asair Signed-off-by: Anshul Dalal --- Changes for v2: - Changed vendor prefix from asair to aosong --- Documentation/devicetree/bindings/vendor-prefixes.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/devicetree/bindings/vendor-prefixes.yaml b/Documentation/devicetree/bindings/vendor-prefixes.yaml index 573578db9509..48d4ff635562 100644 --- a/Documentation/devicetree/bindings/vendor-prefixes.yaml +++ b/Documentation/devicetree/bindings/vendor-prefixes.yaml @@ -117,6 +117,8 @@ patternProperties: description: Andes Technology Corporation "^anvo,.*": description: Anvo-Systems Dresden GmbH + "^aosong,.*": + description: Guangzhou Aosong Electronic Co., Ltd. "^apm,.*": description: Applied Micro Circuits Corporation (APM) "^apple,.*": From patchwork Wed Nov 15 12:58:08 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anshul Dalal X-Patchwork-Id: 744115 Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7CD3118031; Wed, 15 Nov 2023 13:00:26 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="QOOE6TUY" 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 F417D130; Wed, 15 Nov 2023 05:00:22 -0800 (PST) Received: by mail-pf1-x434.google.com with SMTP id d2e1a72fcca58-6c431ca7826so5849230b3a.0; Wed, 15 Nov 2023 05:00:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1700053222; x=1700658022; 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=wMGWOyYs7PfLPnHHX3eEkJL05C/4w6oYrycDGEtP+O8=; b=QOOE6TUYLgGr6kfiybkGWALY/fl9rViuqOKLM29C2GV0XQ72h55aL+NdTGbrZiFkkJ DzOQngHE7k/O5y6Nvivd4/LANUXrvFeSSHHXEyW0Z65BGU3CofWu5ZHMgkXvcnBujoQ5 n4oZs93XgRIpDZKKCuFgc5vjs3sIVuS7xVV0MwwBEtQ/DpGWTnHPKyM2WtCX+1akgiZr MYozOqCTuOclsxXhg074nqstDf/b4wP1e4Rd1VNwL0SyufVa8fKPRYXJ5lXKo+spfMP7 cjyZbyQFIVkK45CG1TFm1Q5SLVJsz2JZApNbwwoKGvGPE+zsqcyi2+CSqaXm3QVJ70Qy MYqg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700053222; x=1700658022; 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=wMGWOyYs7PfLPnHHX3eEkJL05C/4w6oYrycDGEtP+O8=; b=LY0bka8SpW4biZivPE3f1LwQ01ME4XD5kb91ayWs/sZYE24sFDb+ZnuIXQEjn4l/Hf d7HW616pglkQtuWI6GZ/ITlvCbPHjHjw0wQFTQDV3A1lbG4b25Jc/Uvdg76vHlKT/zU5 TjkvSkZXyC3CpoAV44dLv+PBal8do9nRv6xdOsQzbHxzTdHjLqgnMp/uaXiwLW/ls6lR C2OsqHfXhv33eOyCnBcbWKWqR1i5fsFNgmrfa3XeQPxhN8zKt9+FovvodvAc32QbMPd0 BLNOEFaysCJZ5PbqysPVU0SGBQI1QXMF71TTLb7lqOirQTN9Xag2PeDmw3I+7I8Vtehb nhyg== X-Gm-Message-State: AOJu0YxCQMbwgTDUa5/XLRCnRkyyGANOJBsDLKi1uQ5TxgMiFJcMCUmx JqMlUtMXovd6t2yIw2kXorEd7mUNRFUULQ== X-Google-Smtp-Source: AGHT+IG0DCAALxLt73Hxif+HsVVrnfq9qeiEd8MhZnzopAZbDKkX4ez1ojHiT+rNaTkOIS53L78BSg== X-Received: by 2002:a05:6a20:160b:b0:187:858b:8c1a with SMTP id l11-20020a056a20160b00b00187858b8c1amr568604pzj.50.1700053221366; Wed, 15 Nov 2023 05:00:21 -0800 (PST) Received: from localhost.localdomain ([2401:4900:2353:8963:b940:1ac0:2fbc:6b6]) by smtp.gmail.com with ESMTPSA id fh42-20020a056a00392a00b006c4d128b71esm2812867pfb.98.2023.11.15.05.00.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Nov 2023 05:00:20 -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 Subject: [PATCH v2 3/3] iio: chemical: add support for Aosong AGS02MA Date: Wed, 15 Nov 2023 18:28:08 +0530 Message-ID: <20231115125810.1394854-3-anshulusr@gmail.com> X-Mailer: git-send-email 2.42.0 In-Reply-To: <20231115125810.1394854-1-anshulusr@gmail.com> References: <20231115125810.1394854-1-anshulusr@gmail.com> Precedence: bulk X-Mailing-List: devicetree@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 A simple driver for the TVOC (Total Volatile Organic Compounds) sensor from Aosong: AGS02MA Steps in reading the VOC sensor value over i2c: 1. Read 5 bytes from the register `AGS02MA_TVOC_READ_REG` [0x00] 2. The first 4 bytes are taken as the big endian sensor data with final byte being the CRC 3. The CRC is verified and the value is returned over an `IIO_CHAN_INFO_RAW` channel as percents Tested on Raspberry Pi Zero 2W Datasheet: https://asairsensors.com/wp-content/uploads/2021/09/AGS02MA.pdf Product-Page: http://www.aosong.com/m/en/products-33.html Signed-off-by: Anshul Dalal --- Changes for v2: - Fixed Kconfig not selecting CRC8 (used to be `select crc8`) - Changed instances of asair to aosong - Report raw readings in percents instead of ppb - Added myself as maintainer for the device binding --- MAINTAINERS | 7 ++ drivers/iio/chemical/Kconfig | 11 +++ drivers/iio/chemical/Makefile | 1 + drivers/iio/chemical/ags02ma.c | 161 +++++++++++++++++++++++++++++++++ 4 files changed, 180 insertions(+) create mode 100644 drivers/iio/chemical/ags02ma.c diff --git a/MAINTAINERS b/MAINTAINERS index 81d5fc0bba68..07b82e766dbd 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3028,6 +3028,13 @@ S: Supported W: http://www.akm.com/ F: drivers/iio/magnetometer/ak8974.c +AOSONG AGS02MA TVOC SENSOR DRIVER +M: Anshul Dalal +L: linux-iio@vger.kernel.org +S: Maintained +F: Documentation/devicetree/bindings/iio/chemical/aosong,ags02ma.yaml +F: drivers/iio/chemical/ags02ma.c + ASC7621 HARDWARE MONITOR DRIVER M: George Joseph L: linux-hwmon@vger.kernel.org diff --git a/drivers/iio/chemical/Kconfig b/drivers/iio/chemical/Kconfig index c30657e10ee1..02649ab81b3c 100644 --- a/drivers/iio/chemical/Kconfig +++ b/drivers/iio/chemical/Kconfig @@ -5,6 +5,17 @@ menu "Chemical Sensors" +config AOSONG_AGS02MA + tristate "Aosong AGS02MA TVOC sensor driver" + depends on I2C + select CRC8 + help + Say Y here to build support for Aosong AGS02MA TVOC (Total Volatile + Organic Compounds) sensor. + + To compile this driver as module, choose M here: the module will be + called ags02ma. + config ATLAS_PH_SENSOR tristate "Atlas Scientific OEM SM sensors" depends on I2C diff --git a/drivers/iio/chemical/Makefile b/drivers/iio/chemical/Makefile index a11e777a7a00..2f3dee8bb779 100644 --- a/drivers/iio/chemical/Makefile +++ b/drivers/iio/chemical/Makefile @@ -4,6 +4,7 @@ # # When adding new entries keep the list in alphabetical order +obj-$(CONFIG_AOSONG_AGS02MA) += ags02ma.o obj-$(CONFIG_ATLAS_PH_SENSOR) += atlas-sensor.o obj-$(CONFIG_ATLAS_EZO_SENSOR) += atlas-ezo-sensor.o obj-$(CONFIG_BME680) += bme680_core.o diff --git a/drivers/iio/chemical/ags02ma.c b/drivers/iio/chemical/ags02ma.c new file mode 100644 index 000000000000..e23655ffce69 --- /dev/null +++ b/drivers/iio/chemical/ags02ma.c @@ -0,0 +1,161 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Copyright (C) 2023 Anshul Dalal + * + * Driver for Aosong AGS02MA + * + * Datasheet: + * https://asairsensors.com/wp-content/uploads/2021/09/AGS02MA.pdf + * Product Page: + * http://www.aosong.com/m/en/products-33.html + * + * TODO: + * - Add support for ug/m^3 units of measurement + * - Add support for modifying i2c address + */ + +#include +#include +#include +#include +#include + +#define AGS02MA_DEVICE_NAME "ags02ma" + +#define AGS02MA_TVOC_READ_REG 0x00 +#define AGS02MA_VERSION_REG 0x11 + +#define AGS02MA_VERSION_PROCESSING_DELAY 30 +#define AGS02MA_TVOC_READ_PROCESSING_DELAY 1500 + +#define AGS02MA_CRC8_INIT 0xff +#define AGS02MA_CRC8_POLYNOMIAL 0x31 +#define AGS02MA_PPB_PERCENT_CONVERSION 10000000 + +DECLARE_CRC8_TABLE(ags02ma_crc8_table); + +struct ags02ma_data { + struct i2c_client *client; +}; + +struct ags02ma_reading { + __be32 data; + u8 crc; +} __packed; + +static u32 ags02ma_register_read(struct i2c_client *client, u8 reg, u16 delay) +{ + u32 ret; + u8 crc; + struct ags02ma_reading read_buffer; + + ret = i2c_master_send(client, ®, sizeof(reg)); + if (ret < 0) { + dev_err(&client->dev, + "Failed to send data to register 0x%x: %d", reg, ret); + return ret; + } + + /* Processing Delay, Check Table 7.7 in the datasheet */ + msleep_interruptible(delay); + + ret = i2c_master_recv(client, (u8 *)&read_buffer, sizeof(read_buffer)); + if (ret < 0) { + dev_err(&client->dev, + "Failed to receive from register 0x%x: %d", reg, ret); + return ret; + } + ret = be32_to_cpu(read_buffer.data); + + crc = crc8(ags02ma_crc8_table, (u8 *)&read_buffer.data, + sizeof(read_buffer.data), AGS02MA_CRC8_INIT); + if (crc != read_buffer.crc) { + dev_err(&client->dev, "CRC error\n"); + return -EIO; + } + + return ret; +} + +static int ags02ma_read_raw(struct iio_dev *iio_device, + struct iio_chan_spec const *chan, int *val, + int *val2, long mask) +{ + int ret; + struct ags02ma_data *data = iio_priv(iio_device); + + if (mask == IIO_CHAN_INFO_RAW) { + /* The sensor reads data as ppb */ + ret = ags02ma_register_read(data->client, AGS02MA_TVOC_READ_REG, + AGS02MA_TVOC_READ_PROCESSING_DELAY); + if (ret < 0) + return ret; + *val = ret; + *val2 = AGS02MA_PPB_PERCENT_CONVERSION; + return IIO_VAL_FRACTIONAL; + } else { + return -EINVAL; + } +} + +static const struct iio_info ags02ma_info = { + .read_raw = ags02ma_read_raw, +}; + +static const struct iio_chan_spec ags02ma_channels[] = { + { .type = IIO_CONCENTRATION, + .channel2 = IIO_MOD_VOC, + .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) } +}; + +static int ags02ma_probe(struct i2c_client *client) +{ + int ret; + struct ags02ma_data *data; + struct iio_dev *indio_dev; + u32 version; + + indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data)); + if (!indio_dev) + return -ENOMEM; + + crc8_populate_msb(ags02ma_crc8_table, AGS02MA_CRC8_POLYNOMIAL); + + ret = ags02ma_register_read(client, AGS02MA_VERSION_REG, + AGS02MA_VERSION_PROCESSING_DELAY); + if (ret < 0) { + dev_err(&client->dev, "Failed to read device version: %d", ret); + return ret; + } + version = ret; + dev_dbg(&client->dev, "Aosong AGS02MA, Version: 0x%x", version); + + data = iio_priv(indio_dev); + i2c_set_clientdata(client, indio_dev); + data->client = client; + indio_dev->info = &ags02ma_info; + indio_dev->channels = ags02ma_channels; + indio_dev->num_channels = ARRAY_SIZE(ags02ma_channels); + indio_dev->name = AGS02MA_DEVICE_NAME; + + return devm_iio_device_register(&client->dev, indio_dev); +} + +static const struct i2c_device_id ags02ma_id_table[] = { + { AGS02MA_DEVICE_NAME, 0 }, + { /* Sentinel */ } +}; +MODULE_DEVICE_TABLE(i2c, ags02ma_id_table); + +static struct i2c_driver ags02ma_driver = { + .driver = { + .name = AGS02MA_DEVICE_NAME, + }, + .id_table = ags02ma_id_table, + .probe = ags02ma_probe, +}; +module_i2c_driver(ags02ma_driver); + +MODULE_AUTHOR("Anshul Dalal "); +MODULE_DESCRIPTION("Aosong AGS02MA TVOC Driver"); +MODULE_LICENSE("GPL");