path: root/drivers/iio/adc/ad4080.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Analog Devices AD4080 SPI ADC driver
 *
 * Copyright 2025 Analog Devices Inc.
 */

#include <linux/array_size.h>
#include <linux/bitfield.h>
#include <linux/bits.h>
#include <linux/clk.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/iio/backend.h>
#include <linux/iio/iio.h>
#include <linux/mod_devicetable.h>
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/regmap.h>
#include <linux/regulator/consumer.h>
#include <linux/spi/spi.h>
#include <linux/types.h>
#include <linux/unaligned.h>
#include <linux/units.h>

/* Register Definition */
#define AD4080_REG_INTERFACE_CONFIG_A				0x00
#define AD4080_REG_INTERFACE_CONFIG_B				0x01
#define AD4080_REG_DEVICE_CONFIG				0x02
#define AD4080_REG_CHIP_TYPE					0x03
#define AD4080_REG_PRODUCT_ID_L					0x04
#define AD4080_REG_PRODUCT_ID_H					0x05
#define AD4080_REG_CHIP_GRADE					0x06
#define AD4080_REG_SCRATCH_PAD					0x0A
#define AD4080_REG_SPI_REVISION					0x0B
#define AD4080_REG_VENDOR_L					0x0C
#define AD4080_REG_VENDOR_H					0x0D
#define AD4080_REG_STREAM_MODE					0x0E
#define AD4080_REG_TRANSFER_CONFIG				0x0F
#define AD4080_REG_INTERFACE_CONFIG_C				0x10
#define AD4080_REG_INTERFACE_STATUS_A				0x11
#define AD4080_REG_DEVICE_STATUS				0x14
#define AD4080_REG_ADC_DATA_INTF_CONFIG_A			0x15
#define AD4080_REG_ADC_DATA_INTF_CONFIG_B			0x16
#define AD4080_REG_ADC_DATA_INTF_CONFIG_C			0x17
#define AD4080_REG_PWR_CTRL					0x18
#define AD4080_REG_GPIO_CONFIG_A				0x19
#define AD4080_REG_GPIO_CONFIG_B				0x1A
#define AD4080_REG_GPIO_CONFIG_C				0x1B
#define AD4080_REG_GENERAL_CONFIG				0x1C
#define AD4080_REG_FIFO_WATERMARK_LSB				0x1D
#define AD4080_REG_FIFO_WATERMARK_MSB				0x1E
#define AD4080_REG_EVENT_HYSTERESIS_LSB				0x1F
#define AD4080_REG_EVENT_HYSTERESIS_MSB				0x20
#define AD4080_REG_EVENT_DETECTION_HI_LSB			0x21
#define AD4080_REG_EVENT_DETECTION_HI_MSB			0x22
#define AD4080_REG_EVENT_DETECTION_LO_LSB			0x23
#define AD4080_REG_EVENT_DETECTION_LO_MSB			0x24
#define AD4080_REG_OFFSET_LSB					0x25
#define AD4080_REG_OFFSET_MSB					0x26
#define AD4080_REG_GAIN_LSB					0x27
#define AD4080_REG_GAIN_MSB					0x28
#define AD4080_REG_FILTER_CONFIG				0x29

/* AD4080_REG_INTERFACE_CONFIG_A Bit Definition */
#define AD4080_INTERFACE_CONFIG_A_SW_RESET			(BIT(7) | BIT(0))
#define AD4080_INTERFACE_CONFIG_A_ADDR_ASC			BIT(5)
#define AD4080_INTERFACE_CONFIG_A_SDO_ENABLE			BIT(4)

/* AD4080_REG_INTERFACE_CONFIG_B Bit Definition */
#define AD4080_INTERFACE_CONFIG_B_SINGLE_INST			BIT(7)
#define AD4080_INTERFACE_CONFIG_B_SHORT_INST			BIT(3)

/* AD4080_REG_DEVICE_CONFIG Bit Definition */
#define AD4080_DEVICE_CONFIG_OPERATING_MODES_MSK		GENMASK(1, 0)

/* AD4080_REG_TRANSFER_CONFIG Bit Definition */
#define AD4080_TRANSFER_CONFIG_KEEP_STREAM_LENGTH_VAL		BIT(2)

/* AD4080_REG_INTERFACE_CONFIG_C Bit Definition */
#define AD4080_INTERFACE_CONFIG_C_STRICT_REG_ACCESS		BIT(5)

/* AD4080_REG_ADC_DATA_INTF_CONFIG_A Bit Definition */
#define AD4080_ADC_DATA_INTF_CONFIG_A_RESERVED_CONFIG_A		BIT(6)
#define AD4080_ADC_DATA_INTF_CONFIG_A_INTF_CHK_EN		BIT(4)
#define AD4080_ADC_DATA_INTF_CONFIG_A_SPI_LVDS_LANES		BIT(2)
#define AD4080_ADC_DATA_INTF_CONFIG_A_DATA_INTF_MODE		BIT(0)

/* AD4080_REG_ADC_DATA_INTF_CONFIG_B Bit Definition */
#define AD4080_ADC_DATA_INTF_CONFIG_B_LVDS_CNV_CLK_CNT_MSK	GENMASK(7, 4)
#define AD4080_ADC_DATA_INTF_CONFIG_B_LVDS_SELF_CLK_MODE	BIT(3)
#define AD4080_ADC_DATA_INTF_CONFIG_B_LVDS_CNV_EN		BIT(0)

/* AD4080_REG_ADC_DATA_INTF_CONFIG_C Bit Definition */
#define AD4080_ADC_DATA_INTF_CONFIG_C_LVDS_VOD_MSK		GENMASK(6, 4)

/* AD4080_REG_PWR_CTRL Bit Definition */
#define AD4080_PWR_CTRL_ANA_DIG_LDO_PD				BIT(1)
#define AD4080_PWR_CTRL_INTF_LDO_PD				BIT(0)

/* AD4080_REG_GPIO_CONFIG_A Bit Definition */
#define AD4080_GPIO_CONFIG_A_GPO_1_EN				BIT(1)
#define AD4080_GPIO_CONFIG_A_GPO_0_EN				BIT(0)

/* AD4080_REG_GPIO_CONFIG_B Bit Definition */
#define AD4080_GPIO_CONFIG_B_GPIO_1_SEL_MSK			GENMASK(7, 4)
#define AD4080_GPIO_CONFIG_B_GPIO_0_SEL_MSK			GENMASK(3, 0)
#define AD4080_GPIO_CONFIG_B_GPIO_SPI_SDO			0
#define AD4080_GPIO_CONFIG_B_GPIO_FIFO_FULL			1
#define AD4080_GPIO_CONFIG_B_GPIO_FIFO_READ_DONE		2
#define AD4080_GPIO_CONFIG_B_GPIO_FILTER_RES_RDY		3
#define AD4080_GPIO_CONFIG_B_GPIO_H_THRESH			4
#define AD4080_GPIO_CONFIG_B_GPIO_L_THRESH			5
#define AD4080_GPIO_CONFIG_B_GPIO_STATUS_ALERT			6
#define AD4080_GPIO_CONFIG_B_GPIO_GPIO_DATA			7
#define AD4080_GPIO_CONFIG_B_GPIO_FILTER_SYNC			8
#define AD4080_GPIO_CONFIG_B_GPIO_EXTERNAL_EVENT		9

/* AD4080_REG_FIFO_CONFIG Bit Definition */
#define AD4080_FIFO_CONFIG_FIFO_MODE_MSK			GENMASK(1, 0)

/* AD4080_REG_FILTER_CONFIG Bit Definition */
#define AD4080_FILTER_CONFIG_SINC_DEC_RATE_MSK			GENMASK(6, 3)
#define AD4080_FILTER_CONFIG_FILTER_SEL_MSK			GENMASK(1, 0)

/* Miscellaneous Definitions */
#define AD4080_SPI_READ						BIT(7)
#define AD4080_CHIP_ID						GENMASK(2, 0)

#define AD4080_LVDS_CNV_CLK_CNT_MAX				7

#define AD4080_MAX_SAMP_FREQ					40000000
#define AD4080_MIN_SAMP_FREQ					1250000

enum ad4080_filter_type {
	FILTER_NONE,
	SINC_1,
	SINC_5,
	SINC_5_COMP
};

static const unsigned int ad4080_scale_table[][2] = {
	{ 6000, 0 },
};

static const char *const ad4080_filter_type_iio_enum[] = {
	[FILTER_NONE]      = "none",
	[SINC_1]           = "sinc1",
	[SINC_5]           = "sinc5",
	[SINC_5_COMP]      = "sinc5+pf1",
};

static const int ad4080_dec_rate_avail[] = {
	2, 4, 8, 16, 32, 64, 128, 256, 512, 1024,
};

static const int ad4080_dec_rate_none[] = { 1 };

static const char * const ad4080_power_supplies[] = {
	"vdd33", "vdd11", "vddldo", "iovdd", "vrefin",
};

struct ad4080_chip_info {
	const char *name;
	unsigned int product_id;
	int num_scales;
	const unsigned int (*scale_table)[2];
	const struct iio_chan_spec *channels;
	unsigned int num_channels;
};

struct ad4080_state {
	struct regmap			*regmap;
	struct iio_backend		*back;
	const struct ad4080_chip_info	*info;
	/*
	 * Synchronize access to members the of driver state, and ensure
	 * atomicity of consecutive regmap operations.
	 */
	struct mutex			lock;
	unsigned int			num_lanes;
	unsigned int			dec_rate;
	unsigned long			clk_rate;
	enum ad4080_filter_type		filter_type;
	bool				lvds_cnv_en;
};

static const struct regmap_config ad4080_regmap_config = {
	.reg_bits = 16,
	.val_bits = 8,
	.read_flag_mask = BIT(7),
	.max_register = 0x29,
};

static int ad4080_reg_access(struct iio_dev *indio_dev, unsigned int reg,
			     unsigned int writeval, unsigned int *readval)
{
	struct ad4080_state *st = iio_priv(indio_dev);

	if (readval)
		return regmap_read(st->regmap, reg, readval);

	return regmap_write(st->regmap, reg, writeval);
}

static int ad4080_get_scale(struct ad4080_state *st, int *val, int *val2)
{
	unsigned int tmp;

	tmp = (st->info->scale_table[0][0] * 1000000ULL) >>
		    st->info->channels[0].scan_type.realbits;
	*val = tmp / 1000000;
	*val2 = tmp % 1000000;

	return IIO_VAL_INT_PLUS_NANO;
}

static unsigned int ad4080_get_dec_rate(struct iio_dev *dev,
					const struct iio_chan_spec *chan)
{
	struct ad4080_state *st = iio_priv(dev);
	int ret;
	unsigned int data;

	ret = regmap_read(st->regmap, AD4080_REG_FILTER_CONFIG, &data);
	if (ret)
		return ret;

	return 1 << (FIELD_GET(AD4080_FILTER_CONFIG_SINC_DEC_RATE_MSK, data) + 1);
}

static int ad4080_set_dec_rate(struct iio_dev *dev,
			       const struct iio_chan_spec *chan,
			       unsigned int mode)
{
	struct ad4080_state *st = iio_priv(dev);

	guard(mutex)(&st->lock);

	if ((st->filter_type >= SINC_5 && mode >= 512) || mode < 2)
		return -EINVAL;

	return regmap_update_bits(st->regmap, AD4080_REG_FILTER_CONFIG,
				  AD4080_FILTER_CONFIG_SINC_DEC_RATE_MSK,
				  FIELD_PREP(AD4080_FILTER_CONFIG_SINC_DEC_RATE_MSK,
					     (ilog2(mode) - 1)));
}

static int ad4080_read_raw(struct iio_dev *indio_dev,
			   struct iio_chan_spec const *chan,
			   int *val, int *val2, long m)
{
	struct ad4080_state *st = iio_priv(indio_dev);
	int dec_rate;

	switch (m) {
	case IIO_CHAN_INFO_SCALE:
		return ad4080_get_scale(st, val, val2);
	case IIO_CHAN_INFO_SAMP_FREQ:
		dec_rate = ad4080_get_dec_rate(indio_dev, chan);
		if (dec_rate < 0)
			return dec_rate;
		if (st->filter_type == SINC_5_COMP)
			dec_rate *= 2;
		if (st->filter_type)
			*val = DIV_ROUND_CLOSEST(st->clk_rate, dec_rate);
		else
			*val = st->clk_rate;
		return IIO_VAL_INT;
	case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
		if (st->filter_type == FILTER_NONE) {
			*val = 1;
		} else {
			*val = ad4080_get_dec_rate(indio_dev, chan);
			if (*val < 0)
				return *val;
		}
		return IIO_VAL_INT;
	default:
		return -EINVAL;
	}
}

static int ad4080_write_raw(struct iio_dev *indio_dev,
			    struct iio_chan_spec const *chan,
			    int val, int val2, long mask)
{
	struct ad4080_state *st = iio_priv(indio_dev);

	switch (mask) {
	case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
		if (st->filter_type == FILTER_NONE && val > 1)
			return -EINVAL;

		return ad4080_set_dec_rate(indio_dev, chan, val);
	default:
		return -EINVAL;
	}
}

static int ad4080_lvds_sync_write(struct ad4080_state *st)
{
	struct device *dev = regmap_get_device(st->regmap);
	int ret;

	ret = regmap_set_bits(st->regmap, AD4080_REG_ADC_DATA_INTF_CONFIG_A,
			      AD4080_ADC_DATA_INTF_CONFIG_A_INTF_CHK_EN);
	if (ret)
		return ret;

	ret = iio_backend_interface_data_align(st->back, 10000);
	if (ret)
		return dev_err_probe(dev, ret,
				     "Data alignment process failed\n");

	dev_dbg(dev, "Success: Pattern correct and Locked!\n");
	return regmap_clear_bits(st->regmap, AD4080_REG_ADC_DATA_INTF_CONFIG_A,
				 AD4080_ADC_DATA_INTF_CONFIG_A_INTF_CHK_EN);
}

static int ad4080_get_filter_type(struct iio_dev *dev,
				  const struct iio_chan_spec *chan)
{
	struct ad4080_state *st = iio_priv(dev);
	unsigned int data;
	int ret;

	ret = regmap_read(st->regmap, AD4080_REG_FILTER_CONFIG, &data);
	if (ret)
		return ret;

	return FIELD_GET(AD4080_FILTER_CONFIG_FILTER_SEL_MSK, data);
}

static int ad4080_set_filter_type(struct iio_dev *dev,
				  const struct iio_chan_spec *chan,
				  unsigned int mode)
{
	struct ad4080_state *st = iio_priv(dev);
	int dec_rate;
	int ret;

	guard(mutex)(&st->lock);

	dec_rate = ad4080_get_dec_rate(dev, chan);
	if (dec_rate < 0)
		return dec_rate;

	if (mode >= SINC_5 && dec_rate >= 512)
		return -EINVAL;

	ret = iio_backend_filter_type_set(st->back, mode);
	if (ret)
		return ret;

	ret = regmap_update_bits(st->regmap, AD4080_REG_FILTER_CONFIG,
				 AD4080_FILTER_CONFIG_FILTER_SEL_MSK,
				 FIELD_PREP(AD4080_FILTER_CONFIG_FILTER_SEL_MSK,
					    mode));
	if (ret)
		return ret;

	st->filter_type = mode;

	return 0;
}

static int ad4080_read_avail(struct iio_dev *indio_dev,
			     struct iio_chan_spec const *chan,
			     const int **vals, int *type, int *length,
			     long mask)
{
	struct ad4080_state *st = iio_priv(indio_dev);

	switch (mask) {
	case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
		switch (st->filter_type) {
		case FILTER_NONE:
			*vals = ad4080_dec_rate_none;
			*length = ARRAY_SIZE(ad4080_dec_rate_none);
			break;
		default:
			*vals = ad4080_dec_rate_avail;
			*length = st->filter_type >= SINC_5 ?
				  (ARRAY_SIZE(ad4080_dec_rate_avail) - 2) :
				  ARRAY_SIZE(ad4080_dec_rate_avail);
			break;
		}
		*type = IIO_VAL_INT;
		return IIO_AVAIL_LIST;
	default:
		return -EINVAL;
	}
}

static const struct iio_info ad4080_iio_info = {
	.debugfs_reg_access = ad4080_reg_access,
	.read_raw = ad4080_read_raw,
	.write_raw = ad4080_write_raw,
	.read_avail = ad4080_read_avail,
};

static const struct iio_enum ad4080_filter_type_enum = {
	.items = ad4080_filter_type_iio_enum,
	.num_items = ARRAY_SIZE(ad4080_filter_type_iio_enum),
	.set = ad4080_set_filter_type,
	.get = ad4080_get_filter_type,
};

static struct iio_chan_spec_ext_info ad4080_ext_info[] = {
	IIO_ENUM("filter_type", IIO_SHARED_BY_ALL, &ad4080_filter_type_enum),
	IIO_ENUM_AVAILABLE("filter_type", IIO_SHARED_BY_ALL,
			   &ad4080_filter_type_enum),
	{ }
};

static const struct iio_chan_spec ad4080_channel = {
	.type = IIO_VOLTAGE,
	.indexed = 1,
	.channel = 0,
	.info_mask_separate = BIT(IIO_CHAN_INFO_SCALE),
	.info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ) |
			BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
	.info_mask_shared_by_all_available =
			BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),
	.ext_info = ad4080_ext_info,
	.scan_index = 0,
	.scan_type = {
		.sign = 's',
		.realbits = 20,
		.storagebits = 32,
	},
};

static const struct ad4080_chip_info ad4080_chip_info = {
	.name = "ad4080",
	.product_id = AD4080_CHIP_ID,
	.scale_table = ad4080_scale_table,
	.num_scales = ARRAY_SIZE(ad4080_scale_table),
	.num_channels = 1,
	.channels = &ad4080_channel,
};

static int ad4080_setup(struct iio_dev *indio_dev)
{
	struct ad4080_state *st = iio_priv(indio_dev);
	struct device *dev = regmap_get_device(st->regmap);
	unsigned int id;
	int ret;

	ret = regmap_write(st->regmap, AD4080_REG_INTERFACE_CONFIG_A,
			   AD4080_INTERFACE_CONFIG_A_SW_RESET);
	if (ret)
		return ret;

	ret = regmap_write(st->regmap, AD4080_REG_INTERFACE_CONFIG_A,
			   AD4080_INTERFACE_CONFIG_A_SDO_ENABLE);
	if (ret)
		return ret;

	ret = regmap_read(st->regmap, AD4080_REG_CHIP_TYPE, &id);
	if (ret)
		return ret;

	if (id != AD4080_CHIP_ID)
		dev_info(dev, "Unrecognized CHIP_ID 0x%X\n", id);

	ret = regmap_set_bits(st->regmap, AD4080_REG_GPIO_CONFIG_A,
			      AD4080_GPIO_CONFIG_A_GPO_1_EN);
	if (ret)
		return ret;

	ret = regmap_write(st->regmap, AD4080_REG_GPIO_CONFIG_B,
			   FIELD_PREP(AD4080_GPIO_CONFIG_B_GPIO_1_SEL_MSK,
				      AD4080_GPIO_CONFIG_B_GPIO_FILTER_RES_RDY));
	if (ret)
		return ret;

	ret = iio_backend_num_lanes_set(st->back, st->num_lanes);
	if (ret)
		return ret;

	if (!st->lvds_cnv_en)
		return 0;

	/* Set maximum LVDS Data Transfer Latency */
	ret = regmap_update_bits(st->regmap,
				 AD4080_REG_ADC_DATA_INTF_CONFIG_B,
				 AD4080_ADC_DATA_INTF_CONFIG_B_LVDS_CNV_CLK_CNT_MSK,
				 FIELD_PREP(AD4080_ADC_DATA_INTF_CONFIG_B_LVDS_CNV_CLK_CNT_MSK,
					    AD4080_LVDS_CNV_CLK_CNT_MAX));
	if (ret)
		return ret;

	if (st->num_lanes > 1) {
		ret = regmap_set_bits(st->regmap, AD4080_REG_ADC_DATA_INTF_CONFIG_A,
				      AD4080_ADC_DATA_INTF_CONFIG_A_SPI_LVDS_LANES);
		if (ret)
			return ret;
	}

	ret = regmap_set_bits(st->regmap,
			      AD4080_REG_ADC_DATA_INTF_CONFIG_B,
			      AD4080_ADC_DATA_INTF_CONFIG_B_LVDS_CNV_EN);
	if (ret)
		return ret;

	return ad4080_lvds_sync_write(st);
}

static int ad4080_properties_parse(struct ad4080_state *st)
{
	struct device *dev = regmap_get_device(st->regmap);

	st->lvds_cnv_en = device_property_read_bool(dev, "adi,lvds-cnv-enable");

	st->num_lanes = 1;
	device_property_read_u32(dev, "adi,num-lanes", &st->num_lanes);
	if (!st->num_lanes || st->num_lanes > 2)
		return dev_err_probe(dev, -EINVAL,
				     "Invalid 'adi,num-lanes' value: %u",
				     st->num_lanes);

	return 0;
}

static int ad4080_probe(struct spi_device *spi)
{
	struct iio_dev *indio_dev;
	struct device *dev = &spi->dev;
	struct ad4080_state *st;
	struct clk *clk;
	int ret;

	indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
	if (!indio_dev)
		return -ENOMEM;

	st = iio_priv(indio_dev);

	ret = devm_regulator_bulk_get_enable(dev,
					     ARRAY_SIZE(ad4080_power_supplies),
					     ad4080_power_supplies);
	if (ret)
		return dev_err_probe(dev, ret,
				     "failed to get and enable supplies\n");

	st->regmap = devm_regmap_init_spi(spi, &ad4080_regmap_config);
	if (IS_ERR(st->regmap))
		return PTR_ERR(st->regmap);

	st->info = spi_get_device_match_data(spi);
	if (!st->info)
		return -ENODEV;

	ret = devm_mutex_init(dev, &st->lock);
	if (ret)
		return ret;

	indio_dev->name = st->info->name;
	indio_dev->channels = st->info->channels;
	indio_dev->num_channels = st->info->num_channels;
	indio_dev->info = &ad4080_iio_info;

	ret = ad4080_properties_parse(st);
	if (ret)
		return ret;

	clk = devm_clk_get_enabled(&spi->dev, "cnv");
	if (IS_ERR(clk))
		return PTR_ERR(clk);

	st->clk_rate = clk_get_rate(clk);

	st->back = devm_iio_backend_get(dev, NULL);
	if (IS_ERR(st->back))
		return PTR_ERR(st->back);

	ret = devm_iio_backend_request_buffer(dev, st->back, indio_dev);
	if (ret)
		return ret;

	ret = devm_iio_backend_enable(dev, st->back);
	if (ret)
		return ret;

	ret = ad4080_setup(indio_dev);
	if (ret)
		return ret;

	return devm_iio_device_register(&spi->dev, indio_dev);
}

static const struct spi_device_id ad4080_id[] = {
	{ "ad4080", (kernel_ulong_t)&ad4080_chip_info },
	{ }
};
MODULE_DEVICE_TABLE(spi, ad4080_id);

static const struct of_device_id ad4080_of_match[] = {
	{ .compatible = "adi,ad4080", &ad4080_chip_info },
	{ }
};
MODULE_DEVICE_TABLE(of, ad4080_of_match);

static struct spi_driver ad4080_driver = {
	.driver = {
		.name = "ad4080",
		.of_match_table = ad4080_of_match,
	},
	.probe = ad4080_probe,
	.id_table = ad4080_id,
};
module_spi_driver(ad4080_driver);

MODULE_AUTHOR("Antoniu Miclaus <antoniu.miclaus@analog.com");
MODULE_DESCRIPTION("Analog Devices AD4080");
MODULE_LICENSE("GPL");
MODULE_IMPORT_NS("IIO_BACKEND");