cregit-Linux how code gets into the kernel

Release 4.11 drivers/iio/chemical/atlas-ph-sensor.c

/*
 * atlas-ph-sensor.c - Support for Atlas Scientific OEM pH-SM sensor
 *
 * Copyright (C) 2015 Matt Ranostay <mranostay@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/delay.h>
#include <linux/mutex.h>
#include <linux/err.h>
#include <linux/irq.h>
#include <linux/irq_work.h>
#include <linux/gpio.h>
#include <linux/i2c.h>
#include <linux/of_device.h>
#include <linux/regmap.h>
#include <linux/iio/iio.h>
#include <linux/iio/buffer.h>
#include <linux/iio/trigger.h>
#include <linux/iio/trigger_consumer.h>
#include <linux/iio/triggered_buffer.h>
#include <linux/pm_runtime.h>


#define ATLAS_REGMAP_NAME	"atlas_ph_regmap"

#define ATLAS_DRV_NAME		"atlas_ph"


#define ATLAS_REG_DEV_TYPE		0x00

#define ATLAS_REG_DEV_VERSION		0x01


#define ATLAS_REG_INT_CONTROL		0x04

#define ATLAS_REG_INT_CONTROL_EN	BIT(3)


#define ATLAS_REG_PWR_CONTROL		0x06


#define ATLAS_REG_PH_CALIB_STATUS	0x0d

#define ATLAS_REG_PH_CALIB_STATUS_MASK	0x07

#define ATLAS_REG_PH_CALIB_STATUS_LOW	BIT(0)

#define ATLAS_REG_PH_CALIB_STATUS_MID	BIT(1)

#define ATLAS_REG_PH_CALIB_STATUS_HIGH	BIT(2)


#define ATLAS_REG_EC_CALIB_STATUS		0x0f

#define ATLAS_REG_EC_CALIB_STATUS_MASK		0x0f

#define ATLAS_REG_EC_CALIB_STATUS_DRY		BIT(0)

#define ATLAS_REG_EC_CALIB_STATUS_SINGLE	BIT(1)

#define ATLAS_REG_EC_CALIB_STATUS_LOW		BIT(2)

#define ATLAS_REG_EC_CALIB_STATUS_HIGH		BIT(3)


#define ATLAS_REG_PH_TEMP_DATA		0x0e

#define ATLAS_REG_PH_DATA		0x16


#define ATLAS_REG_EC_PROBE		0x08

#define ATLAS_REG_EC_TEMP_DATA		0x10

#define ATLAS_REG_EC_DATA		0x18

#define ATLAS_REG_TDS_DATA		0x1c

#define ATLAS_REG_PSS_DATA		0x20


#define ATLAS_REG_ORP_CALIB_STATUS	0x0d

#define ATLAS_REG_ORP_DATA		0x0e


#define ATLAS_PH_INT_TIME_IN_US		450000

#define ATLAS_EC_INT_TIME_IN_US		650000

#define ATLAS_ORP_INT_TIME_IN_US	450000

enum {
	
ATLAS_PH_SM,
	
ATLAS_EC_SM,
	
ATLAS_ORP_SM,
};


struct atlas_data {
	
struct i2c_client *client;
	
struct iio_trigger *trig;
	
struct atlas_device *chip;
	
struct regmap *regmap;
	
struct irq_work work;

	
__be32 buffer[6]; /* 96-bit data + 32-bit pad + 64-bit timestamp */
};


static const struct regmap_config atlas_regmap_config = {
	.name = ATLAS_REGMAP_NAME,
	.reg_bits = 8,
	.val_bits = 8,
};


static const struct iio_chan_spec atlas_ph_channels[] = {
	{
		.type = IIO_PH,
		.address = ATLAS_REG_PH_DATA,
		.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_BE,
                },
        },
	IIO_CHAN_SOFT_TIMESTAMP(1),
	{
		.type = IIO_TEMP,
		.address = ATLAS_REG_PH_TEMP_DATA,
		.info_mask_separate =
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
		.output = 1,
		.scan_index = -1
	},
};


#define ATLAS_EC_CHANNEL(_idx, _addr) \
	{\
                .type = IIO_CONCENTRATION, \
                .indexed = 1, \
                .channel = _idx, \
                .address = _addr, \
                .info_mask_separate = \
                        BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE), \
                .scan_index = _idx + 1, \
                .scan_type = { \
                        .sign = 'u', \
                        .realbits = 32, \
                        .storagebits = 32, \
                        .endianness = IIO_BE, \
                }, \
        }


static const struct iio_chan_spec atlas_ec_channels[] = {
	{
		.type = IIO_ELECTRICALCONDUCTIVITY,
		.address = ATLAS_REG_EC_DATA,
		.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_BE,
                },
        },
	ATLAS_EC_CHANNEL(0, ATLAS_REG_TDS_DATA),
	ATLAS_EC_CHANNEL(1, ATLAS_REG_PSS_DATA),
	IIO_CHAN_SOFT_TIMESTAMP(3),
	{
		.type = IIO_TEMP,
		.address = ATLAS_REG_EC_TEMP_DATA,
		.info_mask_separate =
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
		.output = 1,
		.scan_index = -1
	},
};


static const struct iio_chan_spec atlas_orp_channels[] = {
	{
		.type = IIO_VOLTAGE,
		.address = ATLAS_REG_ORP_DATA,
		.info_mask_separate =
			BIT(IIO_CHAN_INFO_RAW) | BIT(IIO_CHAN_INFO_SCALE),
		.scan_index = 0,
		.scan_type = {
			.sign = 's',
			.realbits = 32,
			.storagebits = 32,
			.endianness = IIO_BE,
                },
        },
	IIO_CHAN_SOFT_TIMESTAMP(1),
};


static int atlas_check_ph_calibration(struct atlas_data *data) { struct device *dev = &data->client->dev; int ret; unsigned int val; ret = regmap_read(data->regmap, ATLAS_REG_PH_CALIB_STATUS, &val); if (ret) return ret; if (!(val & ATLAS_REG_PH_CALIB_STATUS_MASK)) { dev_warn(dev, "device has not been calibrated\n"); return 0; } if (!(val & ATLAS_REG_PH_CALIB_STATUS_LOW)) dev_warn(dev, "device missing low point calibration\n"); if (!(val & ATLAS_REG_PH_CALIB_STATUS_MID)) dev_warn(dev, "device missing mid point calibration\n"); if (!(val & ATLAS_REG_PH_CALIB_STATUS_HIGH)) dev_warn(dev, "device missing high point calibration\n"); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay123100.00%1100.00%
Total123100.00%1100.00%


static int atlas_check_ec_calibration(struct atlas_data *data) { struct device *dev = &data->client->dev; int ret; unsigned int val; __be16 rval; ret = regmap_bulk_read(data->regmap, ATLAS_REG_EC_PROBE, &rval, 2); if (ret) return ret; val = be16_to_cpu(rval); dev_info(dev, "probe set to K = %d.%.2d", val / 100, val % 100); ret = regmap_read(data->regmap, ATLAS_REG_EC_CALIB_STATUS, &val); if (ret) return ret; if (!(val & ATLAS_REG_EC_CALIB_STATUS_MASK)) { dev_warn(dev, "device has not been calibrated\n"); return 0; } if (!(val & ATLAS_REG_EC_CALIB_STATUS_DRY)) dev_warn(dev, "device missing dry point calibration\n"); if (val & ATLAS_REG_EC_CALIB_STATUS_SINGLE) { dev_warn(dev, "device using single point calibration\n"); } else { if (!(val & ATLAS_REG_EC_CALIB_STATUS_LOW)) dev_warn(dev, "device missing low point calibration\n"); if (!(val & ATLAS_REG_EC_CALIB_STATUS_HIGH)) dev_warn(dev, "device missing high point calibration\n"); } return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay17894.18%150.00%
Sandhya Bankar115.82%150.00%
Total189100.00%2100.00%


static int atlas_check_orp_calibration(struct atlas_data *data) { struct device *dev = &data->client->dev; int ret; unsigned int val; ret = regmap_read(data->regmap, ATLAS_REG_ORP_CALIB_STATUS, &val); if (ret) return ret; if (!val) dev_warn(dev, "device has not been calibrated\n"); return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay66100.00%1100.00%
Total66100.00%1100.00%

; struct atlas_device { const struct iio_chan_spec *channels; int num_channels; int data_reg; int (*calibration)(struct atlas_data *data); int delay; }; static struct atlas_device atlas_devices[] = { [ATLAS_PH_SM] = { .channels = atlas_ph_channels, .num_channels = 3, .data_reg = ATLAS_REG_PH_DATA, .calibration = &atlas_check_ph_calibration, .delay = ATLAS_PH_INT_TIME_IN_US, }, [ATLAS_EC_SM] = { .channels = atlas_ec_channels, .num_channels = 5, .data_reg = ATLAS_REG_EC_DATA, .calibration = &atlas_check_ec_calibration, .delay = ATLAS_EC_INT_TIME_IN_US, }, [ATLAS_ORP_SM] = { .channels = atlas_orp_channels, .num_channels = 2, .data_reg = ATLAS_REG_ORP_DATA, .calibration = &atlas_check_orp_calibration, .delay = ATLAS_ORP_INT_TIME_IN_US, }, };
static int atlas_set_powermode(struct atlas_data *data, int on) { return regmap_write(data->regmap, ATLAS_REG_PWR_CONTROL, on); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay26100.00%1100.00%
Total26100.00%1100.00%


static int atlas_set_interrupt(struct atlas_data *data, bool state) { return regmap_update_bits(data->regmap, ATLAS_REG_INT_CONTROL, ATLAS_REG_INT_CONTROL_EN, state ? ATLAS_REG_INT_CONTROL_EN : 0); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay32100.00%1100.00%
Total32100.00%1100.00%


static int atlas_buffer_postenable(struct iio_dev *indio_dev) { struct atlas_data *data = iio_priv(indio_dev); int ret; ret = iio_triggered_buffer_postenable(indio_dev); if (ret) return ret; ret = pm_runtime_get_sync(&data->client->dev); if (ret < 0) { pm_runtime_put_noidle(&data->client->dev); return ret; } return atlas_set_interrupt(data, true); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay79100.00%1100.00%
Total79100.00%1100.00%


static int atlas_buffer_predisable(struct iio_dev *indio_dev) { struct atlas_data *data = iio_priv(indio_dev); int ret; ret = iio_triggered_buffer_predisable(indio_dev); if (ret) return ret; ret = atlas_set_interrupt(data, false); if (ret) return ret; pm_runtime_mark_last_busy(&data->client->dev); return pm_runtime_put_autosuspend(&data->client->dev); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay75100.00%1100.00%
Total75100.00%1100.00%

static const struct iio_trigger_ops atlas_interrupt_trigger_ops = { .owner = THIS_MODULE, }; static const struct iio_buffer_setup_ops atlas_buffer_setup_ops = { .postenable = atlas_buffer_postenable, .predisable = atlas_buffer_predisable, };
static void atlas_work_handler(struct irq_work *work) { struct atlas_data *data = container_of(work, struct atlas_data, work); iio_trigger_poll(data->trig); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay33100.00%1100.00%
Total33100.00%1100.00%


static irqreturn_t atlas_trigger_handler(int irq, void *private) { struct iio_poll_func *pf = private; struct iio_dev *indio_dev = pf->indio_dev; struct atlas_data *data = iio_priv(indio_dev); int ret; ret = regmap_bulk_read(data->regmap, data->chip->data_reg, (u8 *) &data->buffer, sizeof(__be32) * (data->chip->num_channels - 2)); if (!ret) iio_push_to_buffers_with_timestamp(indio_dev, data->buffer, iio_get_time_ns(indio_dev)); iio_trigger_notify_done(indio_dev->trig); return IRQ_HANDLED; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay10797.27%375.00%
Grégor Boirie32.73%125.00%
Total110100.00%4100.00%


static irqreturn_t atlas_interrupt_handler(int irq, void *private) { struct iio_dev *indio_dev = private; struct atlas_data *data = iio_priv(indio_dev); irq_work_queue(&data->work); return IRQ_HANDLED; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay41100.00%1100.00%
Total41100.00%1100.00%


static int atlas_read_measurement(struct atlas_data *data, int reg, __be32 *val) { struct device *dev = &data->client->dev; int suspended = pm_runtime_suspended(dev); int ret; ret = pm_runtime_get_sync(dev); if (ret < 0) { pm_runtime_put_noidle(dev); return ret; } if (suspended) usleep_range(data->chip->delay, data->chip->delay + 100000); ret = regmap_bulk_read(data->regmap, reg, (u8 *) val, sizeof(*val)); pm_runtime_mark_last_busy(dev); pm_runtime_put_autosuspend(dev); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay121100.00%2100.00%
Total121100.00%2100.00%


static int atlas_read_raw(struct iio_dev *indio_dev, struct iio_chan_spec const *chan, int *val, int *val2, long mask) { struct atlas_data *data = iio_priv(indio_dev); switch (mask) { case IIO_CHAN_INFO_RAW: { int ret; __be32 reg; switch (chan->type) { case IIO_TEMP: ret = regmap_bulk_read(data->regmap, chan->address, (u8 *) &reg, sizeof(reg)); break; case IIO_PH: case IIO_CONCENTRATION: case IIO_ELECTRICALCONDUCTIVITY: case IIO_VOLTAGE: ret = iio_device_claim_direct_mode(indio_dev); if (ret) return ret; ret = atlas_read_measurement(data, chan->address, &reg); iio_device_release_direct_mode(indio_dev); break; default: ret = -EINVAL; } if (!ret) { *val = be32_to_cpu(reg); ret = IIO_VAL_INT; } return ret; } case IIO_CHAN_INFO_SCALE: switch (chan->type) { case IIO_TEMP: *val = 1; /* 0.01 */ *val2 = 100; break; case IIO_PH: *val = 1; /* 0.001 */ *val2 = 1000; break; case IIO_ELECTRICALCONDUCTIVITY: *val = 1; /* 0.00001 */ *val2 = 100000; break; case IIO_CONCENTRATION: *val = 0; /* 0.000000001 */ *val2 = 1000; return IIO_VAL_INT_PLUS_NANO; case IIO_VOLTAGE: *val = 1; /* 0.1 */ *val2 = 10; break; default: return -EINVAL; } return IIO_VAL_FRACTIONAL; } return -EINVAL; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay26599.62%583.33%
Colin Ian King10.38%116.67%
Total266100.00%6100.00%


static int atlas_write_raw(struct iio_dev *indio_dev, struct iio_chan_spec const *chan, int val, int val2, long mask) { struct atlas_data *data = iio_priv(indio_dev); __be32 reg = cpu_to_be32(val); if (val2 != 0 || val < 0 || val > 20000) return -EINVAL; if (mask != IIO_CHAN_INFO_RAW || chan->type != IIO_TEMP) return -EINVAL; return regmap_bulk_write(data->regmap, chan->address, &reg, sizeof(reg)); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay98100.00%1100.00%
Total98100.00%1100.00%

static const struct iio_info atlas_info = { .driver_module = THIS_MODULE, .read_raw = atlas_read_raw, .write_raw = atlas_write_raw, }; static const struct i2c_device_id atlas_id[] = { { "atlas-ph-sm", ATLAS_PH_SM}, { "atlas-ec-sm", ATLAS_EC_SM}, { "atlas-orp-sm", ATLAS_ORP_SM}, {} }; MODULE_DEVICE_TABLE(i2c, atlas_id); static const struct of_device_id atlas_dt_ids[] = { { .compatible = "atlas,ph-sm", .data = (void *)ATLAS_PH_SM, }, { .compatible = "atlas,ec-sm", .data = (void *)ATLAS_EC_SM, }, { .compatible = "atlas,orp-sm", .data = (void *)ATLAS_ORP_SM, }, { } }; MODULE_DEVICE_TABLE(of, atlas_dt_ids);
static int atlas_probe(struct i2c_client *client, const struct i2c_device_id *id) { struct atlas_data *data; struct atlas_device *chip; const struct of_device_id *of_id; struct iio_trigger *trig; struct iio_dev *indio_dev; int ret; indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data)); if (!indio_dev) return -ENOMEM; of_id = of_match_device(atlas_dt_ids, &client->dev); if (!of_id) chip = &atlas_devices[id->driver_data]; else chip = &atlas_devices[(unsigned long)of_id->data]; indio_dev->info = &atlas_info; indio_dev->name = ATLAS_DRV_NAME; indio_dev->channels = chip->channels; indio_dev->num_channels = chip->num_channels; indio_dev->modes = INDIO_BUFFER_SOFTWARE | INDIO_DIRECT_MODE; indio_dev->dev.parent = &client->dev; trig = devm_iio_trigger_alloc(&client->dev, "%s-dev%d", indio_dev->name, indio_dev->id); if (!trig) return -ENOMEM; data = iio_priv(indio_dev); data->client = client; data->trig = trig; data->chip = chip; trig->dev.parent = indio_dev->dev.parent; trig->ops = &atlas_interrupt_trigger_ops; iio_trigger_set_drvdata(trig, indio_dev); i2c_set_clientdata(client, indio_dev); data->regmap = devm_regmap_init_i2c(client, &atlas_regmap_config); if (IS_ERR(data->regmap)) { dev_err(&client->dev, "regmap initialization failed\n"); return PTR_ERR(data->regmap); } ret = pm_runtime_set_active(&client->dev); if (ret) return ret; if (client->irq <= 0) { dev_err(&client->dev, "no valid irq defined\n"); return -EINVAL; } ret = chip->calibration(data); if (ret) return ret; ret = iio_trigger_register(trig); if (ret) { dev_err(&client->dev, "failed to register trigger\n"); return ret; } ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time, &atlas_trigger_handler, &atlas_buffer_setup_ops); if (ret) { dev_err(&client->dev, "cannot setup iio trigger\n"); goto unregister_trigger; } init_irq_work(&data->work, atlas_work_handler); /* interrupt pin toggles on new conversion */ ret = devm_request_threaded_irq(&client->dev, client->irq, NULL, atlas_interrupt_handler, IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING | IRQF_ONESHOT, "atlas_irq", indio_dev); if (ret) { dev_err(&client->dev, "request irq (%d) failed\n", client->irq); goto unregister_buffer; } ret = atlas_set_powermode(data, 1); if (ret) { dev_err(&client->dev, "cannot power device on"); goto unregister_buffer; } pm_runtime_enable(&client->dev); pm_runtime_set_autosuspend_delay(&client->dev, 2500); pm_runtime_use_autosuspend(&client->dev); ret = iio_device_register(indio_dev); if (ret) { dev_err(&client->dev, "unable to register device\n"); goto unregister_pm; } return 0; unregister_pm: pm_runtime_disable(&client->dev); atlas_set_powermode(data, 0); unregister_buffer: iio_triggered_buffer_cleanup(indio_dev); unregister_trigger: iio_trigger_unregister(data->trig); return ret; }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay588100.00%2100.00%
Total588100.00%2100.00%


static int atlas_remove(struct i2c_client *client) { struct iio_dev *indio_dev = i2c_get_clientdata(client); struct atlas_data *data = iio_priv(indio_dev); iio_device_unregister(indio_dev); iio_triggered_buffer_cleanup(indio_dev); iio_trigger_unregister(data->trig); pm_runtime_disable(&client->dev); pm_runtime_set_suspended(&client->dev); pm_runtime_put_noidle(&client->dev); return atlas_set_powermode(data, 0); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay80100.00%1100.00%
Total80100.00%1100.00%

#ifdef CONFIG_PM
static int atlas_runtime_suspend(struct device *dev) { struct atlas_data *data = iio_priv(i2c_get_clientdata(to_i2c_client(dev))); return atlas_set_powermode(data, 0); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay35100.00%1100.00%
Total35100.00%1100.00%


static int atlas_runtime_resume(struct device *dev) { struct atlas_data *data = iio_priv(i2c_get_clientdata(to_i2c_client(dev))); return atlas_set_powermode(data, 1); }

Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay35100.00%1100.00%
Total35100.00%1100.00%

#endif static const struct dev_pm_ops atlas_pm_ops = { SET_RUNTIME_PM_OPS(atlas_runtime_suspend, atlas_runtime_resume, NULL) }; static struct i2c_driver atlas_driver = { .driver = { .name = ATLAS_DRV_NAME, .of_match_table = of_match_ptr(atlas_dt_ids), .pm = &atlas_pm_ops, }, .probe = atlas_probe, .remove = atlas_remove, .id_table = atlas_id, }; module_i2c_driver(atlas_driver); MODULE_AUTHOR("Matt Ranostay <mranostay@gmail.com>"); MODULE_DESCRIPTION("Atlas Scientific pH-SM sensor"); MODULE_LICENSE("GPL");

Overall Contributors

PersonTokensPropCommitsCommitProp
Matthew Ranostay290999.49%666.67%
Sandhya Bankar110.38%111.11%
Grégor Boirie30.10%111.11%
Colin Ian King10.03%111.11%
Total2924100.00%9100.00%
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.