diff mbox series

[v2,1/3] dt-bindings:iio:adc: add generic settling-time-us and average-samples channel properties

Message ID 20210312105515.32055-2-o.rempel@pengutronix.de
State Superseded
Headers show
Series [v2,1/3] dt-bindings:iio:adc: add generic settling-time-us and average-samples channel properties | expand

Commit Message

Oleksij Rempel March 12, 2021, 10:55 a.m. UTC
Settling time and over sampling is a typical challenge for different IIO ADC
devices. So, introduce channel specific settling-time-us and average-samples
properties to cover this use case.

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
 Documentation/devicetree/bindings/iio/adc/adc.yaml | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Jonathan Cameron March 13, 2021, 3:15 p.m. UTC | #1
On Fri, 12 Mar 2021 11:55:13 +0100
Oleksij Rempel <o.rempel@pengutronix.de> wrote:

> Settling time and over sampling is a typical challenge for different IIO ADC

> devices. So, introduce channel specific settling-time-us and average-samples

> properties to cover this use case.

> 

> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>

> ---

>  Documentation/devicetree/bindings/iio/adc/adc.yaml | 9 +++++++++

>  1 file changed, 9 insertions(+)

> 

> diff --git a/Documentation/devicetree/bindings/iio/adc/adc.yaml b/Documentation/devicetree/bindings/iio/adc/adc.yaml

> index 912a7635edc4..c748f6573027 100644

> --- a/Documentation/devicetree/bindings/iio/adc/adc.yaml

> +++ b/Documentation/devicetree/bindings/iio/adc/adc.yaml

> @@ -39,4 +39,13 @@ properties:

>        The first value specifies the positive input pin, the second

>        specifies the negative input pin.

>  

> +  settling-time-us:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    description:

> +      Time between enabling the channel and firs stable readings.


first

> +

> +  average-samples:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    description: Number of data samples which are averaged for each read.


So in IIO at least, we tend to refer to this as oversampling.  Perhaps we
should use that term here as well?  It would also be good to give some hint
as to why this might be a DT property rather than a userspace control.

Thanks,

Jonathan

> +

>  additionalProperties: true
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/adc.yaml b/Documentation/devicetree/bindings/iio/adc/adc.yaml
index 912a7635edc4..c748f6573027 100644
--- a/Documentation/devicetree/bindings/iio/adc/adc.yaml
+++ b/Documentation/devicetree/bindings/iio/adc/adc.yaml
@@ -39,4 +39,13 @@  properties:
       The first value specifies the positive input pin, the second
       specifies the negative input pin.
 
+  settling-time-us:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Time between enabling the channel and firs stable readings.
+
+  average-samples:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: Number of data samples which are averaged for each read.
+
 additionalProperties: true