diff mbox series

[v3,1/2] iio:adc:ad7476: Handle the different regulators used by various parts.

Message ID 20210424170346.526242-2-jic23@kernel.org (mailing list archive)
State New, archived
Headers show
Series iio:adc:ad7476: Regulator support and binding doc | expand

Commit Message

Jonathan Cameron April 24, 2021, 5:03 p.m. UTC 
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Not all of the parts supported by this driver use single supply.
Hence we add chip_info fields to say what additional supplies exist
and in the case of vref, ensure that is used for the reference voltage
rather than vcc.

One corner case is the ad7091r which has an internal reference that
can be over-driven by an external reference connected on the vref pin.
To handle that force_ext_vref is introduced and set if an optional
vref regulator is present.

Tested using really simple QEMU model and some fixed regulators.

The devm_add_action_or_reset() callback is changed to take the
regulator as it's parameter so we can use one callback for all the
different regulators without having to store pointers to them in
the iio_priv() structure.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Michael Hennerich <michael.hennerich@analog.com>
Reported-by: kernel test robot <lkp@intel.com>
---
 drivers/iio/adc/ad7476.c | 116 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 101 insertions(+), 15 deletions(-)

Comments

Lars-Peter Clausen April 24, 2021, 6:20 p.m. UTC | #1 
On 4/24/21 7:03 PM, Jonathan Cameron wrote:
> [...]
>   
> +	/* Either vcc or vref (below) as appropriate */
> +	if (!st->chip_info->int_vref_uv)
> +		st->ref_reg = reg;
> +
> +	if (st->chip_info->has_vref) {
> +
> +		/* If a device has an internal reference vref is optional */
> +		if (st->chip_info->int_vref_uv) {
> +			reg = devm_regulator_get_optional(&spi->dev, "vref");
> +		} else {
> +			reg = devm_regulator_get(&spi->dev, "vref");
> +			if (IS_ERR(reg))
> +				return PTR_ERR(reg);
> +		}
> +
> +		if (!IS_ERR(reg)) {
> +			ret = regulator_enable(reg);
> +			if (ret)
> +				return ret;
> +
> +			ret = devm_add_action_or_reset(&spi->dev,
> +						       ad7476_reg_disable,
> +						       reg);
> +			if (ret)
> +				return ret;
> +			st->ref_reg = reg;
> +		} else {
We still need to check for errors, e.g. to support EPROBE_DEFER. The 
only error that can be ignored is ENOENT, which means no regulator is 
specified.
> +			/*
> +			 * Can only get here if device supports both internal
> +			 * and external reference, but the regulator connected
> +			 * to the external reference is not connected.
> +			 * Set the reference regulator pointer to NULL to
> +			 * indicate this.
> +			 */
> +			st->ref_reg = NULL;
> +		}
> +	}
Jonathan Cameron April 25, 2021, 3:18 p.m. UTC | #2 
On Sat, 24 Apr 2021 20:20:41 +0200
Lars-Peter Clausen <lars@metafoo.de> wrote:

> On 4/24/21 7:03 PM, Jonathan Cameron wrote:
> > [...]
> >   
> > +	/* Either vcc or vref (below) as appropriate */
> > +	if (!st->chip_info->int_vref_uv)
> > +		st->ref_reg = reg;
> > +
> > +	if (st->chip_info->has_vref) {
> > +
> > +		/* If a device has an internal reference vref is optional */
> > +		if (st->chip_info->int_vref_uv) {
> > +			reg = devm_regulator_get_optional(&spi->dev, "vref");
> > +		} else {
> > +			reg = devm_regulator_get(&spi->dev, "vref");
> > +			if (IS_ERR(reg))
> > +				return PTR_ERR(reg);
> > +		}
> > +
> > +		if (!IS_ERR(reg)) {
> > +			ret = regulator_enable(reg);
> > +			if (ret)
> > +				return ret;
> > +
> > +			ret = devm_add_action_or_reset(&spi->dev,
> > +						       ad7476_reg_disable,
> > +						       reg);
> > +			if (ret)
> > +				return ret;
> > +			st->ref_reg = reg;
> > +		} else {  
> We still need to check for errors, e.g. to support EPROBE_DEFER. The 
> only error that can be ignored is ENOENT, which means no regulator is 
> specified.
Good point.  I got fixated on all the different combinations and forgot the
simple 'error' case :)

V4 coming up.

Jonathan

> > +			/*
> > +			 * Can only get here if device supports both internal
> > +			 * and external reference, but the regulator connected
> > +			 * to the external reference is not connected.
> > +			 * Set the reference regulator pointer to NULL to
> > +			 * indicate this.
> > +			 */
> > +			st->ref_reg = NULL;
> > +		}
> > +	}  
>
Jonathan Cameron April 25, 2021, 4:02 p.m. UTC | #3 
On Sun, 25 Apr 2021 16:18:02 +0100
Jonathan Cameron <jic23@kernel.org> wrote:

> On Sat, 24 Apr 2021 20:20:41 +0200
> Lars-Peter Clausen <lars@metafoo.de> wrote:
> 
> > On 4/24/21 7:03 PM, Jonathan Cameron wrote:  
> > > [...]
> > >   
> > > +	/* Either vcc or vref (below) as appropriate */
> > > +	if (!st->chip_info->int_vref_uv)
> > > +		st->ref_reg = reg;
> > > +
> > > +	if (st->chip_info->has_vref) {
> > > +
> > > +		/* If a device has an internal reference vref is optional */
> > > +		if (st->chip_info->int_vref_uv) {
> > > +			reg = devm_regulator_get_optional(&spi->dev, "vref");
> > > +		} else {
> > > +			reg = devm_regulator_get(&spi->dev, "vref");
> > > +			if (IS_ERR(reg))
> > > +				return PTR_ERR(reg);
> > > +		}
> > > +
> > > +		if (!IS_ERR(reg)) {
> > > +			ret = regulator_enable(reg);
> > > +			if (ret)
> > > +				return ret;
> > > +
> > > +			ret = devm_add_action_or_reset(&spi->dev,
> > > +						       ad7476_reg_disable,
> > > +						       reg);
> > > +			if (ret)
> > > +				return ret;
> > > +			st->ref_reg = reg;
> > > +		} else {    
> > We still need to check for errors, e.g. to support EPROBE_DEFER. The 
> > only error that can be ignored is ENOENT, which means no regulator is 
> > specified.  
> Good point.  I got fixated on all the different combinations and forgot the
> simple 'error' case :)

As far as I can tell -ENODEV is the return for no regulator specified.

Jonathan

> 
> V4 coming up.
> 
> Jonathan
> 
> > > +			/*
> > > +			 * Can only get here if device supports both internal
> > > +			 * and external reference, but the regulator connected
> > > +			 * to the external reference is not connected.
> > > +			 * Set the reference regulator pointer to NULL to
> > > +			 * indicate this.
> > > +			 */
> > > +			st->ref_reg = NULL;
> > > +		}
> > > +	}    
> >   
>
Lars-Peter Clausen April 25, 2021, 4:07 p.m. UTC | #4 
On 4/25/21 6:02 PM, Jonathan Cameron wrote:
> On Sun, 25 Apr 2021 16:18:02 +0100
> Jonathan Cameron <jic23@kernel.org> wrote:
>
>> On Sat, 24 Apr 2021 20:20:41 +0200
>> Lars-Peter Clausen <lars@metafoo.de> wrote:
>>
>>> On 4/24/21 7:03 PM, Jonathan Cameron wrote:
>>>> [...]
>>>>    
>>>> +	/* Either vcc or vref (below) as appropriate */
>>>> +	if (!st->chip_info->int_vref_uv)
>>>> +		st->ref_reg = reg;
>>>> +
>>>> +	if (st->chip_info->has_vref) {
>>>> +
>>>> +		/* If a device has an internal reference vref is optional */
>>>> +		if (st->chip_info->int_vref_uv) {
>>>> +			reg = devm_regulator_get_optional(&spi->dev, "vref");
>>>> +		} else {
>>>> +			reg = devm_regulator_get(&spi->dev, "vref");
>>>> +			if (IS_ERR(reg))
>>>> +				return PTR_ERR(reg);
>>>> +		}
>>>> +
>>>> +		if (!IS_ERR(reg)) {
>>>> +			ret = regulator_enable(reg);
>>>> +			if (ret)
>>>> +				return ret;
>>>> +
>>>> +			ret = devm_add_action_or_reset(&spi->dev,
>>>> +						       ad7476_reg_disable,
>>>> +						       reg);
>>>> +			if (ret)
>>>> +				return ret;
>>>> +			st->ref_reg = reg;
>>>> +		} else {
>>> We still need to check for errors, e.g. to support EPROBE_DEFER. The
>>> only error that can be ignored is ENOENT, which means no regulator is
>>> specified.
>> Good point.  I got fixated on all the different combinations and forgot the
>> simple 'error' case :)
> As far as I can tell -ENODEV is the return for no regulator specified.

Yes. We even have a few examples like the ad7124 driver.
diff mbox series

Patch

diff --git a/drivers/iio/adc/ad7476.c b/drivers/iio/adc/ad7476.c
index 9e9ff07cf972..22991cda932a 100644
--- a/drivers/iio/adc/ad7476.c
+++ b/drivers/iio/adc/ad7476.c
@@ -32,12 +32,14 @@  struct ad7476_chip_info {
 	/* channels used when convst gpio is defined */
 	struct iio_chan_spec		convst_channel[2];
 	void (*reset)(struct ad7476_state *);
+	bool				has_vref;
+	bool				has_vdrive;
 };
 
 struct ad7476_state {
 	struct spi_device		*spi;
 	const struct ad7476_chip_info	*chip_info;
-	struct regulator		*reg;
+	struct regulator		*ref_reg;
 	struct gpio_desc		*convst_gpio;
 	struct spi_transfer		xfer;
 	struct spi_message		msg;
@@ -52,13 +54,17 @@  struct ad7476_state {
 };
 
 enum ad7476_supported_device_ids {
+	ID_AD7091,
 	ID_AD7091R,
+	ID_AD7273,
+	ID_AD7274,
 	ID_AD7276,
 	ID_AD7277,
 	ID_AD7278,
 	ID_AD7466,
 	ID_AD7467,
 	ID_AD7468,
+	ID_AD7475,
 	ID_AD7495,
 	ID_AD7940,
 	ID_ADC081S,
@@ -145,8 +151,8 @@  static int ad7476_read_raw(struct iio_dev *indio_dev,
 			GENMASK(st->chip_info->channel[0].scan_type.realbits - 1, 0);
 		return IIO_VAL_INT;
 	case IIO_CHAN_INFO_SCALE:
-		if (!st->chip_info->int_vref_uv) {
-			scale_uv = regulator_get_voltage(st->reg);
+		if (st->ref_reg) {
+			scale_uv = regulator_get_voltage(st->ref_reg);
 			if (scale_uv < 0)
 				return scale_uv;
 		} else {
@@ -187,13 +193,32 @@  static int ad7476_read_raw(struct iio_dev *indio_dev,
 		BIT(IIO_CHAN_INFO_RAW))
 
 static const struct ad7476_chip_info ad7476_chip_info_tbl[] = {
+	[ID_AD7091] = {
+		.channel[0] = AD7091R_CHAN(12),
+		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
+		.convst_channel[0] = AD7091R_CONVST_CHAN(12),
+		.convst_channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
+		.reset = ad7091_reset,
+	},
 	[ID_AD7091R] = {
 		.channel[0] = AD7091R_CHAN(12),
 		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
 		.convst_channel[0] = AD7091R_CONVST_CHAN(12),
 		.convst_channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
+		.int_vref_uv = 2500000,
+		.has_vref = true,
 		.reset = ad7091_reset,
 	},
+	[ID_AD7273] = {
+		.channel[0] = AD7940_CHAN(10),
+		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
+		.has_vref = true,
+	},
+	[ID_AD7274] = {
+		.channel[0] = AD7940_CHAN(12),
+		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
+		.has_vref = true,
+	},
 	[ID_AD7276] = {
 		.channel[0] = AD7940_CHAN(12),
 		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
@@ -218,10 +243,17 @@  static const struct ad7476_chip_info ad7476_chip_info_tbl[] = {
 		.channel[0] = AD7476_CHAN(8),
 		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
 	},
+	[ID_AD7475] = {
+		.channel[0] = AD7476_CHAN(12),
+		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
+		.has_vref = true,
+		.has_vdrive = true,
+	},
 	[ID_AD7495] = {
 		.channel[0] = AD7476_CHAN(12),
 		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
 		.int_vref_uv = 2500000,
+		.has_vdrive = true,
 	},
 	[ID_AD7940] = {
 		.channel[0] = AD7940_CHAN(14),
@@ -254,6 +286,7 @@  static const struct ad7476_chip_info ad7476_chip_info_tbl[] = {
 	[ID_LTC2314_14] = {
 		.channel[0] = AD7940_CHAN(14),
 		.channel[1] = IIO_CHAN_SOFT_TIMESTAMP(1),
+		.has_vref = true,
 	},
 };
 
@@ -263,15 +296,16 @@  static const struct iio_info ad7476_info = {
 
 static void ad7476_reg_disable(void *data)
 {
-	struct ad7476_state *st = data;
+	struct regulator *reg = data;
 
-	regulator_disable(st->reg);
+	regulator_disable(reg);
 }
 
 static int ad7476_probe(struct spi_device *spi)
 {
 	struct ad7476_state *st;
 	struct iio_dev *indio_dev;
+	struct regulator *reg;
 	int ret;
 
 	indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
@@ -282,19 +316,71 @@  static int ad7476_probe(struct spi_device *spi)
 	st->chip_info =
 		&ad7476_chip_info_tbl[spi_get_device_id(spi)->driver_data];
 
-	st->reg = devm_regulator_get(&spi->dev, "vcc");
-	if (IS_ERR(st->reg))
-		return PTR_ERR(st->reg);
+	reg = devm_regulator_get(&spi->dev, "vcc");
+	if (IS_ERR(reg))
+		return PTR_ERR(reg);
 
-	ret = regulator_enable(st->reg);
+	ret = regulator_enable(reg);
 	if (ret)
 		return ret;
 
-	ret = devm_add_action_or_reset(&spi->dev, ad7476_reg_disable,
-				       st);
+	ret = devm_add_action_or_reset(&spi->dev, ad7476_reg_disable, reg);
 	if (ret)
 		return ret;
 
+	/* Either vcc or vref (below) as appropriate */
+	if (!st->chip_info->int_vref_uv)
+		st->ref_reg = reg;
+
+	if (st->chip_info->has_vref) {
+
+		/* If a device has an internal reference vref is optional */
+		if (st->chip_info->int_vref_uv) {
+			reg = devm_regulator_get_optional(&spi->dev, "vref");
+		} else {
+			reg = devm_regulator_get(&spi->dev, "vref");
+			if (IS_ERR(reg))
+				return PTR_ERR(reg);
+		}
+
+		if (!IS_ERR(reg)) {
+			ret = regulator_enable(reg);
+			if (ret)
+				return ret;
+
+			ret = devm_add_action_or_reset(&spi->dev,
+						       ad7476_reg_disable,
+						       reg);
+			if (ret)
+				return ret;
+			st->ref_reg = reg;
+		} else {
+			/*
+			 * Can only get here if device supports both internal
+			 * and external reference, but the regulator connected
+			 * to the external reference is not connected.
+			 * Set the reference regulator pointer to NULL to
+			 * indicate this.
+			 */
+			st->ref_reg = NULL;
+		}
+	}
+
+	if (st->chip_info->has_vdrive) {
+		reg = devm_regulator_get(&spi->dev, "vdrive");
+		if (IS_ERR(reg))
+			return PTR_ERR(reg);
+
+		ret = regulator_enable(reg);
+		if (ret)
+			return ret;
+
+		ret = devm_add_action_or_reset(&spi->dev, ad7476_reg_disable,
+					       reg);
+		if (ret)
+			return ret;
+	}
+
 	st->convst_gpio = devm_gpiod_get_optional(&spi->dev,
 						  "adi,conversion-start",
 						  GPIOD_OUT_LOW);
@@ -333,17 +419,17 @@  static int ad7476_probe(struct spi_device *spi)
 }
 
 static const struct spi_device_id ad7476_id[] = {
-	{"ad7091", ID_AD7091R},
+	{"ad7091", ID_AD7091},
 	{"ad7091r", ID_AD7091R},
-	{"ad7273", ID_AD7277},
-	{"ad7274", ID_AD7276},
+	{"ad7273", ID_AD7273},
+	{"ad7274", ID_AD7274},
 	{"ad7276", ID_AD7276},
 	{"ad7277", ID_AD7277},
 	{"ad7278", ID_AD7278},
 	{"ad7466", ID_AD7466},
 	{"ad7467", ID_AD7467},
 	{"ad7468", ID_AD7468},
-	{"ad7475", ID_AD7466},
+	{"ad7475", ID_AD7475},
 	{"ad7476", ID_AD7466},
 	{"ad7476a", ID_AD7466},
 	{"ad7477", ID_AD7467},