Received-SPF: pass (google.com: domain of linux-kernel+bounces-169503-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Message-ID: <9cfbe67f24cf4e0f69ee7f3769d85469e0738ee2.camel@gmail.com>
Subject: Re: [PATCH RFC v6 09/10] iio: adc: ad7380: add support for rolling
 average oversampling mode
From: Nuno =?ISO-8859-1?Q?S=E1?= <noname.nuno@gmail.com>
To: Julien Stephan <jstephan@baylibre.com>, Lars-Peter Clausen
 <lars@metafoo.de>,  Michael Hennerich <Michael.Hennerich@analog.com>, Nuno
 =?ISO-8859-1?Q?S=E1?= <nuno.sa@analog.com>, David Lechner
 <dlechner@baylibre.com>, Jonathan Cameron <jic23@kernel.org>, Rob Herring
 <robh@kernel.org>, Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
  Conor Dooley <conor+dt@kernel.org>, Liam Girdwood <lgirdwood@gmail.com>,
 Mark Brown <broonie@kernel.org>
Cc: kernel test robot <lkp@intel.com>, linux-iio@vger.kernel.org, 
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org
Date: Mon, 06 May 2024 10:33:23 +0200
In-Reply-To: <20240501-adding-new-ad738x-driver-v6-9-3c0741154728@baylibre.com>
References: 
	<20240501-adding-new-ad738x-driver-v6-0-3c0741154728@baylibre.com>
	 <20240501-adding-new-ad738x-driver-v6-9-3c0741154728@baylibre.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.50.4 (3.50.4-1.fc39) 
Precedence: bulk
MIME-Version: 1.0

On Wed, 2024-05-01 at 16:55 +0200, Julien Stephan wrote:
> Adds support for rolling average oversampling mode.
>=20
> Rolling oversampling mode uses a first in, first out (FIFO) buffer of
> the most recent samples in the averaging calculation, allowing the ADC
> throughput rate and output data rate to stay the same, since we only need
> to take only one sample for each new conversion.
>=20
> The FIFO length is 8, thus the available oversampling ratios are 1, 2, 4,=
 8
> in this mode (vs 1,=C2=A0 2, 4, 8, 16, 32 for the normal average)
>=20
> In order to be able to change the averaging mode, this commit also adds
> the new "oversampling_mode" and "oversampling_mode_available" custom
> attributes along with the according documentation file in
> Documentation/ABI/testing/sysfs-bus-iio-adc-ad7380 since no standard
> attributes correspond to this use case.
>=20
> Signed-off-by: Julien Stephan <jstephan@baylibre.com>
> ---
> =C2=A0Documentation/ABI/testing/sysfs-bus-iio-adc-ad7380 |=C2=A0 38 +++++=
+
> =C2=A0MAINTAINERS=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=
=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 |=C2=A0=C2=A0 1 +
> =C2=A0drivers/iio/adc/ad7380.c=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=
=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 | 143 +++++++++++++++++++--
> =C2=A03 files changed, 174 insertions(+), 8 deletions(-)
>=20
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7380
> b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7380
> new file mode 100644
> index 000000000000..0a560ef3e32a
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad7380
> @@ -0,0 +1,38 @@
> +What: /sys/bus/iio/devices/iio:deviceX/oversampling_mode
> +KernelVersion: 6.9
> +Contact: Michael Hennerich <michael.hennerich@analog.com>
> +Description:
> +=C2=A0=C2=A0=C2=A0 Writing this attribute sets the oversampling average =
mode.
> +=C2=A0=C2=A0=C2=A0 Reading it, shows the configured mode.
> +=C2=A0=C2=A0=C2=A0 Available modes can be displayed using the oversampli=
ng_mode_available
> +=C2=A0=C2=A0=C2=A0 attribute.
> +=C2=A0=C2=A0=C2=A0 When writing this attribute to change the oversamplin=
g mode, this will
> +=C2=A0=C2=A0=C2=A0 have the following side effects:
> +
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 - soft reset the ADC to flush the oversam=
pling block and FIFO
> +
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 - the available oversampling ratios depen=
d on the oversampling mode
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 configured so to avoid miscon=
figuration, changing the mode will disable
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 the oversampling by setting t=
he ratio to 1.

Hmm, can we somehow re-enable it again with a proper configuration (after t=
he mode
change)?

> +
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 - the list of available ratios (displayed=
 by reading the
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 oversampling_ratio_available =
attribute) will be updated when changing
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 the oversampling mode.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/oversampling_mode_available
> +KernelVersion: 6.9
> +Contact: Michael Hennerich <michael.hennerich@analog.com>
> +Description:
> +=C2=A0=C2=A0=C2=A0 Display the available oversampling average modes. The=
 two available modes
> +=C2=A0=C2=A0=C2=A0 are "normal" and "rolling" where "normal" average mod=
e is the default one.
> +
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 - normal averaging involves taking a numb=
er of samples, adding them
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 together, and dividing the re=
sult by the number of samples taken.
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 This result is then output fr=
om the device. The sample data is cleared
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 when the process completes. B=
ecause we need more samples to output a
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 value, the data output rate d=
ecrease with the oversampling ratio.
> +
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 - rolling oversampling mode uses a first =
in, first out (FIFO) buffer of
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 the most recent samples in th=
e averaging calculation, allowing the ADC
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 throughput rate and output da=
ta rate to stay the same, since we only need
> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 to take only one sample for e=
ach new conversion.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 87724a9e9f9f..ca1e115f2aff 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -434,6 +434,7 @@ R:	David Lechner <dlechner@baylibre.com>
> =C2=A0S:	Supported
> =C2=A0W:=09
> https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad=
738x
> =C2=A0W:	https://ez.analog.com/linux-software-drivers
> +F:	Documentation/ABI/testing/sysfs-bus-iio-adc-ad7380
> =C2=A0F:	Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
> =C2=A0F:	drivers/iio/adc/ad7380.c
> =C2=A0
> diff --git a/drivers/iio/adc/ad7380.c b/drivers/iio/adc/ad7380.c
> index 1e3869f5e48c..7b021bb9cf87 100644
> --- a/drivers/iio/adc/ad7380.c
> +++ b/drivers/iio/adc/ad7380.c
> @@ -51,6 +51,8 @@
> =C2=A0#define AD7380_REG_ADDR_ALERT_HIGH_TH	0x5
> =C2=A0
> =C2=A0#define AD7380_CONFIG1_OS_MODE		BIT(9)
> +#define OS_MODE_NORMAL_AVERAGE		0
> +#define OS_MODE_ROLLING_AVERAGE		1

no AD7380 prefix?

> =C2=A0#define AD7380_CONFIG1_OSR		GENMASK(8, 6)
> =C2=A0#define AD7380_CONFIG1_CRC_W		BIT(5)
> =C2=A0#define AD7380_CONFIG1_CRC_R		BIT(4)
> @@ -159,16 +161,27 @@ static const struct ad7380_timing_specs ad7380_4_ti=
ming =3D {
> =C2=A0	.t_csh_ns =3D 20,
> =C2=A0};
> =C2=A0

..

>=20
> +static ssize_t oversampling_mode_store(struct device *dev,
> +				=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 struct device_attribute *attr,
> +				=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 const char *buf, size_t len)
> +{
> +	struct iio_dev *indio_dev =3D dev_to_iio_dev(dev);
> +	struct ad7380_state *st =3D iio_priv(indio_dev);
> +	int os_mode, ret;
> +
> +	ret =3D sysfs_match_string(ad7380_oversampling_average_modes, buf);
> +	if (ret < 0)
> +		return ret;
> +
> +	os_mode =3D ret;
> +
> +	iio_device_claim_direct_scoped(return -EBUSY, indio_dev) {
> +		ret =3D regmap_update_bits(st->regmap, AD7380_REG_ADDR_CONFIG1,
> +					 AD7380_CONFIG1_OS_MODE,
> +					 FIELD_PREP(AD7380_CONFIG1_OS_MODE,
> os_mode));
> +
> +		if (ret)
> +			return=C2=A0 ret;
> +
> +		st->oversampling_mode =3D os_mode;
> +
> +		/*
> +		 * Oversampling ratio depends on oversampling mode, to avoid
> +		 * misconfiguration when changing oversampling mode,
> +		 * disable oversampling by setting OSR to 0.
> +		 */

Given the comment, I would expect you to disable osr before changing the mo=
de.

> +		ret =3D regmap_update_bits(st->regmap, AD7380_REG_ADDR_CONFIG1,
> +					 AD7380_CONFIG1_OSR,
> FIELD_PREP(AD7380_CONFIG1_OSR, 0));
> +
> +		if (ret)
> +			return ret;
> +
> +		st->oversampling_ratio =3D 1;
> +

1?

Also, it would be nice if we could re-enabled osr. So the flow would maybe =
be:

1) disable osr;
2) change mode;
3) do whatever we need so configuration makes sense for new mode?
4) re-enable osr;
5) soft-reset;

Also not sure if 4) and 5) are in the correct order.

> +		/*
> +		 * Perform a soft reset.
> +		 * This will flush the oversampling block and FIFO but will
> +		 * maintain the content of the configurable registers.
> +		 */
> +		ret =3D regmap_update_bits(st->regmap, AD7380_REG_ADDR_CONFIG2,
> +					 AD7380_CONFIG2_RESET,
> +					 FIELD_PREP(AD7380_CONFIG2_RESET,
> +						=C2=A0=C2=A0=C2=A0 AD7380_CONFIG2_RESET_SOFT));
> +	}
> +	return ret ?: len;
> +}
> +
> +static ssize_t oversampling_mode_available_show(struct device *dev,
> +						struct device_attribute *attr,
> char *buf)
> +{
> +	int i;
> +	size_t len =3D 0;
> +
> +	for (i =3D 0; i < ARRAY_SIZE(ad7380_oversampling_average_modes); i++)
> +		len +=3D sysfs_emit_at(buf, len, "%s ",
> ad7380_oversampling_average_modes[i]);
> +
> +	buf[len - 1] =3D '\n';
> +
> +	return len;
> +}
> +
> +static IIO_DEVICE_ATTR_RW(oversampling_mode, 0);
> +static IIO_DEVICE_ATTR_RO(oversampling_mode_available, 0);
> +
> +static struct attribute *ad7380_attributes[] =3D {
> +	&iio_dev_attr_oversampling_mode.dev_attr.attr,
> +	&iio_dev_attr_oversampling_mode_available.dev_attr.attr,
> +	NULL
> +};
> +

Maybe use IIO_ENUM... It allows the core to do some of the stuff you're doi=
ng for
you.


- Nuno S=C3=A1