[PATCH v2 0/2] iio: chemical: add atlas-ezo-sensor initial support

[PATCH v2 0/2] iio: chemical: add atlas-ezo-sensor initial support

[Matt Ranostay]

Add driver for Alas Scientific EZO sensors with initial support for CO2
sensors.

Changes from v1:
* add comments to mutex
* change IIO_CHAN_INFO_SCALE return from IIO_VAL_FRACTIONAL
  to VAL_INT_PLUS_MICRO
* fix return path atlas_ezo_read_raw() to EINVAL in correct locations

Matt Ranostay (2):
  dt-bindings: iio: chemical: add CO2 EZO module documentation
  iio: chemical: add atlas-ezo-sensor initial support

 .../bindings/iio/chemical/atlas,sensor.yaml   |   6 +-
 drivers/iio/chemical/Kconfig                  |  11 ++
 drivers/iio/chemical/Makefile                 |   1 +
 drivers/iio/chemical/atlas-ezo-sensor.c       | 178 ++++++++++++++++++
 4 files changed, 194 insertions(+), 2 deletions(-)
 create mode 100644 drivers/iio/chemical/atlas-ezo-sensor.c

-- 
2.20.1

[PATCH v2 1/2] dt-bindings: iio: chemical: add CO2 EZO module documentation

[Matt Ranostay]

Cc: devicetree@vger.kernel.org
Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
---
 .../devicetree/bindings/iio/chemical/atlas,sensor.yaml      | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml b/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml
index edcd2904d50e..0d109e1b34ee 100644
--- a/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml
+++ b/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml
@@ -4,19 +4,20 @@
 $id: http://devicetree.org/schemas/iio/chemical/atlas,sensor.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: Atlas Scientific OEM sensors
+title: Atlas Scientific OEM + EZO sensors
 
 maintainers:
   - Matt Ranostay <matt.ranostay@konsulko.com>
 
 description: |
-  Atlas Scientific OEM sensors connected via I2C
+  Atlas Scientific OEM + EZO sensors connected via I2C
 
   Datasheets:
     http://www.atlas-scientific.com/_files/_datasheets/_oem/DO_oem_datasheet.pdf
     http://www.atlas-scientific.com/_files/_datasheets/_oem/EC_oem_datasheet.pdf
     http://www.atlas-scientific.com/_files/_datasheets/_oem/ORP_oem_datasheet.pdf
     http://www.atlas-scientific.com/_files/_datasheets/_oem/pH_oem_datasheet.pdf
+    http://www.atlas-scientific.com/_files/_datasheets/_probe/EZO_CO2_Datasheet.pdf
 
 properties:
   compatible:
@@ -25,6 +26,7 @@ properties:
       - atlas,ec-sm
       - atlas,orp-sm
       - atlas,ph-sm
+      - atlas,co2-ezo
 
   reg:
      maxItems: 1
-- 
2.20.1

[PATCH v2 2/2] iio: chemical: add atlas-ezo-sensor initial support

[Matt Ranostay]

Add driver for Atlas EZO line of sensors with initial support for
CO2 the sensor. This is effectively ASCII strings proxied over I2C
due to these series of sensors being by default UART.

Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
---
 drivers/iio/chemical/Kconfig            |  11 ++
 drivers/iio/chemical/Makefile           |   1 +
 drivers/iio/chemical/atlas-ezo-sensor.c | 178 ++++++++++++++++++++++++
 3 files changed, 190 insertions(+)
 create mode 100644 drivers/iio/chemical/atlas-ezo-sensor.c

diff --git a/drivers/iio/chemical/Kconfig b/drivers/iio/chemical/Kconfig
index a7e65a59bf42..7f21afd73b1c 100644
--- a/drivers/iio/chemical/Kconfig
+++ b/drivers/iio/chemical/Kconfig
@@ -22,6 +22,17 @@ config ATLAS_PH_SENSOR
 	  To compile this driver as module, choose M here: the
 	  module will be called atlas-ph-sensor.
 
+config ATLAS_EZO_SENSOR
+	tristate "Atlas Scientific EZO sensors"
+	depends on I2C
+	help
+	  Say Y here to build I2C interface support for the following
+	  Atlas Scientific EZO sensors
+	    * CO2 EZO Sensor
+
+	  To compile this driver as module, choose M here: the
+	  module will be called atlas-ezo-sensor.
+
 config BME680
 	tristate "Bosch Sensortec BME680 sensor driver"
 	depends on (I2C || SPI)
diff --git a/drivers/iio/chemical/Makefile b/drivers/iio/chemical/Makefile
index 33d3a595dda9..aba4167db745 100644
--- a/drivers/iio/chemical/Makefile
+++ b/drivers/iio/chemical/Makefile
@@ -5,6 +5,7 @@
 
 # When adding new entries keep the list in alphabetical order
 obj-$(CONFIG_ATLAS_PH_SENSOR)	+= atlas-sensor.o
+obj-$(CONFIG_ATLAS_EZO_SENSOR)	+= atlas-ezo-sensor.o
 obj-$(CONFIG_BME680) += bme680_core.o
 obj-$(CONFIG_BME680_I2C) += bme680_i2c.o
 obj-$(CONFIG_BME680_SPI) += bme680_spi.o
diff --git a/drivers/iio/chemical/atlas-ezo-sensor.c b/drivers/iio/chemical/atlas-ezo-sensor.c
new file mode 100644
index 000000000000..009bfad49546
--- /dev/null
+++ b/drivers/iio/chemical/atlas-ezo-sensor.c
@@ -0,0 +1,178 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * atlas-ezo-sensor.c - Support for Atlas Scientific EZO sensors
+ *
+ * Copyright (C) 2020 Konsulko Group
+ * Author: Matt Ranostay <matt.ranostay@konsulko.com>
+ */
+
+#include <linux/module.h>
+#include <linux/init.h>
+#include <linux/delay.h>
+#include <linux/mutex.h>
+#include <linux/err.h>
+#include <linux/i2c.h>
+#include <linux/of_device.h>
+#include <linux/iio/iio.h>
+
+#define ATLAS_EZO_DRV_NAME		"atlas-ezo-sensor"
+#define ATLAS_CO2_INT_TIME_IN_MS	950
+
+enum {
+	ATLAS_CO2_EZO,
+};
+
+struct atlas_ezo_device {
+	const struct iio_chan_spec *channels;
+	int num_channels;
+	int delay;
+};
+
+struct atlas_ezo_data {
+	struct i2c_client *client;
+	struct atlas_ezo_device *chip;
+
+	// locking mutex to avoid multiple concurrent read calls
+	struct mutex lock;
+
+	u8 buffer[8];
+};
+
+static const struct iio_chan_spec atlas_co2_ezo_channels[] = {
+	{
+		.type = IIO_CONCENTRATION,
+		.modified = 1,
+		.channel2 = IIO_MOD_CO2,
+		.info_mask_separate =
+			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
+		.scan_index = 0,
+		.scan_type = {
+			.sign = 'u',
+			.realbits = 32,
+			.storagebits = 32,
+			.endianness = IIO_CPU,
+		},
+	},
+};
+
+static struct atlas_ezo_device atlas_ezo_devices[] = {
+	[ATLAS_CO2_EZO] = {
+		.channels = atlas_co2_ezo_channels,
+		.num_channels = 1,
+		.delay = ATLAS_CO2_INT_TIME_IN_MS,
+	},
+};
+
+static int atlas_ezo_read_raw(struct iio_dev *indio_dev,
+			  struct iio_chan_spec const *chan,
+			  int *val, int *val2, long mask)
+{
+	struct atlas_ezo_data *data = iio_priv(indio_dev);
+	struct i2c_client *client = data->client;
+	int ret = 0;
+
+	if (chan->type != IIO_CONCENTRATION)
+		return -EINVAL;
+
+	switch (mask) {
+	case IIO_CHAN_INFO_RAW: {
+		long tmp;
+
+		mutex_lock(&data->lock);
+
+		tmp = i2c_smbus_write_byte(client, 'R');
+
+		if (tmp < 0) {
+			mutex_unlock(&data->lock);
+			return tmp;
+		}
+
+		msleep(data->chip->delay);
+
+		tmp = i2c_master_recv(client, data->buffer, sizeof(data->buffer));
+
+		// Confirm response code is 1 for success
+		if (tmp < 0 || data->buffer[0] != 1) {
+			mutex_unlock(&data->lock);
+			return -EBUSY;
+		}
+
+		ret = kstrtol(data->buffer + 1, 10, &tmp);
+
+		*val = tmp;
+
+		mutex_unlock(&data->lock);
+
+		return ret ? ret : IIO_VAL_INT;
+	}
+	case IIO_CHAN_INFO_SCALE:
+		*val = 0;
+		*val2 = 100; /* 0.0001 */
+		return IIO_VAL_INT_PLUS_MICRO;
+	}
+
+	return ret;
+}
+
+static const struct iio_info atlas_info = {
+	.read_raw = atlas_ezo_read_raw,
+};
+
+static const struct i2c_device_id atlas_ezo_id[] = {
+	{ "atlas-co2-ezo", ATLAS_CO2_EZO },
+	{}
+};
+MODULE_DEVICE_TABLE(i2c, atlas_ezo_id);
+
+static const struct of_device_id atlas_ezo_dt_ids[] = {
+	{ .compatible = "atlas,co2-ezo", .data = (void *)ATLAS_CO2_EZO, },
+	{}
+};
+MODULE_DEVICE_TABLE(of, atlas_ezo_dt_ids);
+
+static int atlas_ezo_probe(struct i2c_client *client,
+		       const struct i2c_device_id *id)
+{
+	struct atlas_ezo_data *data;
+	struct atlas_ezo_device *chip;
+	const struct of_device_id *of_id;
+	struct iio_dev *indio_dev;
+
+	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
+	if (!indio_dev)
+		return -ENOMEM;
+
+	of_id = of_match_device(atlas_ezo_dt_ids, &client->dev);
+	if (!of_id)
+		chip = &atlas_ezo_devices[id->driver_data];
+	else
+		chip = &atlas_ezo_devices[(unsigned long)of_id->data];
+
+	indio_dev->info = &atlas_info;
+	indio_dev->name = ATLAS_EZO_DRV_NAME;
+	indio_dev->channels = chip->channels;
+	indio_dev->num_channels = chip->num_channels;
+	indio_dev->modes = INDIO_DIRECT_MODE;
+	indio_dev->dev.parent = &client->dev;
+
+	data = iio_priv(indio_dev);
+	data->client = client;
+	data->chip = chip;
+	mutex_init(&data->lock);
+
+	return devm_iio_device_register(&client->dev, indio_dev);
+};
+
+static struct i2c_driver atlas_ezo_driver = {
+	.driver = {
+		.name	= ATLAS_EZO_DRV_NAME,
+		.of_match_table	= atlas_ezo_dt_ids,
+	},
+	.probe		= atlas_ezo_probe,
+	.id_table	= atlas_ezo_id,
+};
+module_i2c_driver(atlas_ezo_driver);
+
+MODULE_AUTHOR("Matt Ranostay <matt.ranostay@konsulko.com>");
+MODULE_DESCRIPTION("Atlas Scientific EZO sensors");
+MODULE_LICENSE("GPL");
-- 
2.20.1

Re: [PATCH v2 2/2] iio: chemical: add atlas-ezo-sensor initial support

[Jonathan Cameron]

On Mon, 11 May 2020 05:32:14 +0300
Matt Ranostay <matt.ranostay@konsulko.com> wrote:

> Add driver for Atlas EZO line of sensors with initial support for
> CO2 the sensor. This is effectively ASCII strings proxied over I2C
> due to these series of sensors being by default UART.
> 
> Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
Two tiny things inline.  Rather than go around again I'll just
fix them up whilst applying.

DT binding is trivial enough that *crosses fingers* shouldn't be
a problem!  Subject to the fuzz from crossing with your RTD driver
anyway

Applied to the togreg branch of iio.git and pushed out as testing
for the autobuilders to poke at it.

Thanks,

Jonathan

> ---
>  drivers/iio/chemical/Kconfig            |  11 ++
>  drivers/iio/chemical/Makefile           |   1 +
>  drivers/iio/chemical/atlas-ezo-sensor.c | 178 ++++++++++++++++++++++++
>  3 files changed, 190 insertions(+)
>  create mode 100644 drivers/iio/chemical/atlas-ezo-sensor.c
> 
> diff --git a/drivers/iio/chemical/Kconfig b/drivers/iio/chemical/Kconfig
> index a7e65a59bf42..7f21afd73b1c 100644
> --- a/drivers/iio/chemical/Kconfig
> +++ b/drivers/iio/chemical/Kconfig
> @@ -22,6 +22,17 @@ config ATLAS_PH_SENSOR
>  	  To compile this driver as module, choose M here: the
>  	  module will be called atlas-ph-sensor.
>  
> +config ATLAS_EZO_SENSOR
> +	tristate "Atlas Scientific EZO sensors"
> +	depends on I2C
> +	help
> +	  Say Y here to build I2C interface support for the following
> +	  Atlas Scientific EZO sensors
> +	    * CO2 EZO Sensor
> +
> +	  To compile this driver as module, choose M here: the
> +	  module will be called atlas-ezo-sensor.
> +
>  config BME680
>  	tristate "Bosch Sensortec BME680 sensor driver"
>  	depends on (I2C || SPI)
> diff --git a/drivers/iio/chemical/Makefile b/drivers/iio/chemical/Makefile
> index 33d3a595dda9..aba4167db745 100644
> --- a/drivers/iio/chemical/Makefile
> +++ b/drivers/iio/chemical/Makefile
> @@ -5,6 +5,7 @@
>  
>  # When adding new entries keep the list in alphabetical order
>  obj-$(CONFIG_ATLAS_PH_SENSOR)	+= atlas-sensor.o
> +obj-$(CONFIG_ATLAS_EZO_SENSOR)	+= atlas-ezo-sensor.o
>  obj-$(CONFIG_BME680) += bme680_core.o
>  obj-$(CONFIG_BME680_I2C) += bme680_i2c.o
>  obj-$(CONFIG_BME680_SPI) += bme680_spi.o
> diff --git a/drivers/iio/chemical/atlas-ezo-sensor.c b/drivers/iio/chemical/atlas-ezo-sensor.c
> new file mode 100644
> index 000000000000..009bfad49546
> --- /dev/null
> +++ b/drivers/iio/chemical/atlas-ezo-sensor.c
> @@ -0,0 +1,178 @@
> +// SPDX-License-Identifier: GPL-2.0+
> +/*
> + * atlas-ezo-sensor.c - Support for Atlas Scientific EZO sensors
> + *
> + * Copyright (C) 2020 Konsulko Group
> + * Author: Matt Ranostay <matt.ranostay@konsulko.com>
> + */
> +
> +#include <linux/module.h>
> +#include <linux/init.h>
> +#include <linux/delay.h>
> +#include <linux/mutex.h>
> +#include <linux/err.h>
> +#include <linux/i2c.h>
> +#include <linux/of_device.h>
> +#include <linux/iio/iio.h>
> +
> +#define ATLAS_EZO_DRV_NAME		"atlas-ezo-sensor"
> +#define ATLAS_CO2_INT_TIME_IN_MS	950
> +
> +enum {
> +	ATLAS_CO2_EZO,
> +};
> +
> +struct atlas_ezo_device {
> +	const struct iio_chan_spec *channels;
> +	int num_channels;
> +	int delay;
> +};
> +
> +struct atlas_ezo_data {
> +	struct i2c_client *client;
> +	struct atlas_ezo_device *chip;
> +
> +	// locking mutex to avoid multiple concurrent read calls
Comment syntax in IIO and most of kernel is
/* ... */

> +	struct mutex lock;
> +
> +	u8 buffer[8];
> +};
> +
> +static const struct iio_chan_spec atlas_co2_ezo_channels[] = {
> +	{
> +		.type = IIO_CONCENTRATION,
> +		.modified = 1,
> +		.channel2 = IIO_MOD_CO2,
> +		.info_mask_separate =
> +			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
> +		.scan_index = 0,
> +		.scan_type = {
> +			.sign = 'u',
> +			.realbits = 32,
> +			.storagebits = 32,
> +			.endianness = IIO_CPU,
> +		},
> +	},
> +};
> +
> +static struct atlas_ezo_device atlas_ezo_devices[] = {
> +	[ATLAS_CO2_EZO] = {
> +		.channels = atlas_co2_ezo_channels,
> +		.num_channels = 1,
> +		.delay = ATLAS_CO2_INT_TIME_IN_MS,
> +	},
> +};
> +
> +static int atlas_ezo_read_raw(struct iio_dev *indio_dev,
> +			  struct iio_chan_spec const *chan,
> +			  int *val, int *val2, long mask)
> +{
> +	struct atlas_ezo_data *data = iio_priv(indio_dev);
> +	struct i2c_client *client = data->client;
> +	int ret = 0;
> +
> +	if (chan->type != IIO_CONCENTRATION)
> +		return -EINVAL;
> +
> +	switch (mask) {
> +	case IIO_CHAN_INFO_RAW: {
> +		long tmp;
> +
> +		mutex_lock(&data->lock);
> +
> +		tmp = i2c_smbus_write_byte(client, 'R');
> +
> +		if (tmp < 0) {
> +			mutex_unlock(&data->lock);
> +			return tmp;
> +		}
> +
> +		msleep(data->chip->delay);
> +
> +		tmp = i2c_master_recv(client, data->buffer, sizeof(data->buffer));
> +
> +		// Confirm response code is 1 for success

Umm?  Guess you meant to drop that comment and have indeed
confirmed this!

> +		if (tmp < 0 || data->buffer[0] != 1) {
> +			mutex_unlock(&data->lock);
> +			return -EBUSY;
> +		}
> +
> +		ret = kstrtol(data->buffer + 1, 10, &tmp);
> +
> +		*val = tmp;
> +
> +		mutex_unlock(&data->lock);
> +
> +		return ret ? ret : IIO_VAL_INT;
> +	}
> +	case IIO_CHAN_INFO_SCALE:
> +		*val = 0;
> +		*val2 = 100; /* 0.0001 */
> +		return IIO_VAL_INT_PLUS_MICRO;
> +	}
> +
> +	return ret;
> +}
> +
> +static const struct iio_info atlas_info = {
> +	.read_raw = atlas_ezo_read_raw,
> +};
> +
> +static const struct i2c_device_id atlas_ezo_id[] = {
> +	{ "atlas-co2-ezo", ATLAS_CO2_EZO },
> +	{}
> +};
> +MODULE_DEVICE_TABLE(i2c, atlas_ezo_id);
> +
> +static const struct of_device_id atlas_ezo_dt_ids[] = {
> +	{ .compatible = "atlas,co2-ezo", .data = (void *)ATLAS_CO2_EZO, },
> +	{}
> +};
> +MODULE_DEVICE_TABLE(of, atlas_ezo_dt_ids);
> +
> +static int atlas_ezo_probe(struct i2c_client *client,
> +		       const struct i2c_device_id *id)
> +{
> +	struct atlas_ezo_data *data;
> +	struct atlas_ezo_device *chip;
> +	const struct of_device_id *of_id;
> +	struct iio_dev *indio_dev;
> +
> +	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
> +	if (!indio_dev)
> +		return -ENOMEM;
> +
> +	of_id = of_match_device(atlas_ezo_dt_ids, &client->dev);
> +	if (!of_id)
> +		chip = &atlas_ezo_devices[id->driver_data];
> +	else
> +		chip = &atlas_ezo_devices[(unsigned long)of_id->data];
> +
> +	indio_dev->info = &atlas_info;
> +	indio_dev->name = ATLAS_EZO_DRV_NAME;
> +	indio_dev->channels = chip->channels;
> +	indio_dev->num_channels = chip->num_channels;
> +	indio_dev->modes = INDIO_DIRECT_MODE;
> +	indio_dev->dev.parent = &client->dev;
> +
> +	data = iio_priv(indio_dev);
> +	data->client = client;
> +	data->chip = chip;
> +	mutex_init(&data->lock);
> +
> +	return devm_iio_device_register(&client->dev, indio_dev);
> +};
> +
> +static struct i2c_driver atlas_ezo_driver = {
> +	.driver = {
> +		.name	= ATLAS_EZO_DRV_NAME,
> +		.of_match_table	= atlas_ezo_dt_ids,
> +	},
> +	.probe		= atlas_ezo_probe,
> +	.id_table	= atlas_ezo_id,
> +};
> +module_i2c_driver(atlas_ezo_driver);
> +
> +MODULE_AUTHOR("Matt Ranostay <matt.ranostay@konsulko.com>");
> +MODULE_DESCRIPTION("Atlas Scientific EZO sensors");
> +MODULE_LICENSE("GPL");

Re: [PATCH v2 1/2] dt-bindings: iio: chemical: add CO2 EZO module documentation

[Jonathan Cameron]

On Mon, 11 May 2020 05:32:13 +0300
Matt Ranostay <matt.ranostay@konsulko.com> wrote:

> Cc: devicetree@vger.kernel.org
> Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
This crossed with the RTD driver, so applied with fuzz to the togreg
branch of iio.git and pushed out as testing for the autobuilders to play
with it.  As ever if a DT maintainer wants to comment there is still
time to add tags (though in this case it is trivial enough I'd not waste
your time reading it!)

Jonathan

> ---
>  .../devicetree/bindings/iio/chemical/atlas,sensor.yaml      | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml b/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml
> index edcd2904d50e..0d109e1b34ee 100644
> --- a/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml
> +++ b/Documentation/devicetree/bindings/iio/chemical/atlas,sensor.yaml
> @@ -4,19 +4,20 @@
>  $id: http://devicetree.org/schemas/iio/chemical/atlas,sensor.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>  
> -title: Atlas Scientific OEM sensors
> +title: Atlas Scientific OEM + EZO sensors
>  
>  maintainers:
>    - Matt Ranostay <matt.ranostay@konsulko.com>
>  
>  description: |
> -  Atlas Scientific OEM sensors connected via I2C
> +  Atlas Scientific OEM + EZO sensors connected via I2C
>  
>    Datasheets:
>      http://www.atlas-scientific.com/_files/_datasheets/_oem/DO_oem_datasheet.pdf
>      http://www.atlas-scientific.com/_files/_datasheets/_oem/EC_oem_datasheet.pdf
>      http://www.atlas-scientific.com/_files/_datasheets/_oem/ORP_oem_datasheet.pdf
>      http://www.atlas-scientific.com/_files/_datasheets/_oem/pH_oem_datasheet.pdf
> +    http://www.atlas-scientific.com/_files/_datasheets/_probe/EZO_CO2_Datasheet.pdf
>  
>  properties:
>    compatible:
> @@ -25,6 +26,7 @@ properties:
>        - atlas,ec-sm
>        - atlas,orp-sm
>        - atlas,ph-sm
> +      - atlas,co2-ezo
>  
>    reg:
>       maxItems: 1