From: Christophe Leroy <christophe.leroy@csgroup.eu>
To: Herve Codina <herve.codina@bootlin.com>,
Liam Girdwood <lgirdwood@gmail.com>,
Mark Brown <broonie@kernel.org>, Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Conor Dooley <conor+dt@kernel.org>,
Jonathan Cameron <jic23@kernel.org>,
Lars-Peter Clausen <lars@metafoo.de>,
Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>,
Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>,
Andy Shevchenko <andy.shevchenko@gmail.com>
Cc: "alsa-devel@alsa-project.org" <alsa-devel@alsa-project.org>,
"devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"linux-iio@vger.kernel.org" <linux-iio@vger.kernel.org>,
Wojciech Ziemba <wojciech.ziemba@intel.com>,
Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Jonathan Cameron <Jonathan.Cameron@huawei.com>
Subject: Re: [PATCH v6 04/13] iio: consumer.h: Fix raw values documentation notes
Date: Tue, 27 Jun 2023 09:55:19 +0000 [thread overview]
Message-ID: <ae318459-43a2-386b-5fce-7a07fd7c6f99@csgroup.eu> (raw)
In-Reply-To: <20230623085830.749991-5-herve.codina@bootlin.com>
Le 23/06/2023 à 10:58, Herve Codina a écrit :
> The raw values notes mention 'ADC counts' and are not fully accurate.
>
> Reword the notes in order to remove the 'ADC counts' and describe the
> conversion needed between a raw value and a value in the standard units.
>
> Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Reviewed-by: Christophe Leroy <christophe.leroy@csgroup.eu>
> ---
> include/linux/iio/consumer.h | 25 +++++++++++++++----------
> 1 file changed, 15 insertions(+), 10 deletions(-)
>
> diff --git a/include/linux/iio/consumer.h b/include/linux/iio/consumer.h
> index 6802596b017c..f536820b9cf2 100644
> --- a/include/linux/iio/consumer.h
> +++ b/include/linux/iio/consumer.h
> @@ -201,8 +201,9 @@ struct iio_dev
> * @chan: The channel being queried.
> * @val: Value read back.
> *
> - * Note raw reads from iio channels are in adc counts and hence
> - * scale will need to be applied if standard units required.
> + * Note, if standard units are required, raw reads from iio channels
> + * need the offset (default 0) and scale (default 1) to be applied
> + * as (raw + offset) * scale.
> */
> int iio_read_channel_raw(struct iio_channel *chan,
> int *val);
> @@ -212,8 +213,9 @@ int iio_read_channel_raw(struct iio_channel *chan,
> * @chan: The channel being queried.
> * @val: Value read back.
> *
> - * Note raw reads from iio channels are in adc counts and hence
> - * scale will need to be applied if standard units required.
> + * Note, if standard units are required, raw reads from iio channels
> + * need the offset (default 0) and scale (default 1) to be applied
> + * as (raw + offset) * scale.
> *
> * In opposit to the normal iio_read_channel_raw this function
> * returns the average of multiple reads.
> @@ -281,8 +283,9 @@ int iio_read_channel_attribute(struct iio_channel *chan, int *val,
> * @chan: The channel being queried.
> * @val: Value being written.
> *
> - * Note raw writes to iio channels are in dac counts and hence
> - * scale will need to be applied if standard units required.
> + * Note that for raw writes to iio channels, if the value provided is
> + * in standard units, the affect of the scale and offset must be removed
> + * as (value / scale) - offset.
> */
> int iio_write_channel_raw(struct iio_channel *chan, int val);
>
> @@ -292,8 +295,9 @@ int iio_write_channel_raw(struct iio_channel *chan, int val);
> * @chan: The channel being queried.
> * @val: Value read back.
> *
> - * Note raw reads from iio channels are in adc counts and hence
> - * scale will need to be applied if standard units are required.
> + * Note, if standard units are required, raw reads from iio channels
> + * need the offset (default 0) and scale (default 1) to be applied
> + * as (raw + offset) * scale.
> */
> int iio_read_max_channel_raw(struct iio_channel *chan, int *val);
>
> @@ -308,8 +312,9 @@ int iio_read_max_channel_raw(struct iio_channel *chan, int *val);
> * For ranges, three vals are always returned; min, step and max.
> * For lists, all the possible values are enumerated.
> *
> - * Note raw available values from iio channels are in adc counts and
> - * hence scale will need to be applied if standard units are required.
> + * Note, if standard units are required, raw available values from iio
> + * channels need the offset (default 0) and scale (default 1) to be applied
> + * as (raw + offset) * scale.
> */
> int iio_read_avail_channel_raw(struct iio_channel *chan,
> const int **vals, int *length);
next prev parent reply other threads:[~2023-06-27 9:56 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-23 8:58 [PATCH v6 00/13] Add support for IIO devices in ASoC Herve Codina
2023-06-23 8:58 ` [PATCH v6 01/13] ASoC: dt-bindings: Add audio-iio-aux Herve Codina
2023-06-27 9:53 ` Christophe Leroy
2023-06-27 9:54 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 02/13] ASoC: dt-bindings: simple-card: Add additional-devs subnode Herve Codina
2023-06-27 9:53 ` Christophe Leroy
2023-06-27 9:54 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 03/13] iio: inkern: Check error explicitly in iio_channel_read_max() Herve Codina
2023-06-27 9:54 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 04/13] iio: consumer.h: Fix raw values documentation notes Herve Codina
2023-06-27 9:55 ` Christophe Leroy [this message]
2023-06-23 8:58 ` [PATCH v6 05/13] iio: inkern: Remove the 'unused' variable usage in iio_channel_read_max() Herve Codina
2023-06-27 9:56 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 06/13] iio: inkern: Fix headers inclusion order Herve Codina
2023-06-27 9:56 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 07/13] minmax: Introduce {min,max}_array() Herve Codina
2023-06-27 9:57 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 08/13] iio: inkern: Use max_array() to get the maximum value from an array Herve Codina
2023-06-27 9:57 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 09/13] iio: inkern: Replace a FIXME comment by a TODO one Herve Codina
2023-06-27 9:57 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 10/13] iio: inkern: Add a helper to query an available minimum raw value Herve Codina
2023-06-27 9:58 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 11/13] ASoC: soc-dapm.h: Convert macros to return a compound literal Herve Codina
2023-06-27 10:00 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 12/13] ASoC: codecs: Add support for the generic IIO auxiliary devices Herve Codina
2023-06-27 10:01 ` Christophe Leroy
2023-06-23 8:58 ` [PATCH v6 13/13] ASoC: simple-card: Handle additional devices Herve Codina
2023-06-27 10:02 ` Christophe Leroy
2023-07-12 11:46 ` [PATCH v6 00/13] Add support for IIO devices in ASoC Mark Brown
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ae318459-43a2-386b-5fce-7a07fd7c6f99@csgroup.eu \
--to=christophe.leroy@csgroup.eu \
--cc=Jonathan.Cameron@huawei.com \
--cc=alsa-devel@alsa-project.org \
--cc=andy.shevchenko@gmail.com \
--cc=broonie@kernel.org \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=herve.codina@bootlin.com \
--cc=jic23@kernel.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=kuninori.morimoto.gx@renesas.com \
--cc=lars@metafoo.de \
--cc=lgirdwood@gmail.com \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=perex@perex.cz \
--cc=robh+dt@kernel.org \
--cc=thomas.petazzoni@bootlin.com \
--cc=tiwai@suse.com \
--cc=wojciech.ziemba@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®