2019-04-01 17:35:19

by Andreas Klinger

Subject: [PATCH v2] avia-hx711.yaml: transform DT binding to YAML

replace avia-hx711.txt by avia-hx711.yaml as yaml devicetree
documentation for avia hx711 iio adc sensor

Signed-off-by: Andreas Klinger <[email protected]>
---
.../devicetree/bindings/iio/adc/avia-hx711.txt | 24 --------
.../devicetree/bindings/iio/adc/avia-hx711.yaml | 66 ++++++++++++++++++++++
2 files changed, 66 insertions(+), 24 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/iio/adc/avia-hx711.txt
create mode 100644 Documentation/devicetree/bindings/iio/adc/avia-hx711.yaml

diff --git a/Documentation/devicetree/bindings/iio/adc/avia-hx711.txt b/Documentation/devicetree/bindings/iio/adc/avia-hx711.txt
deleted file mode 100644
index 7222328a3d0d..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/avia-hx711.txt
+++ /dev/null
@@ -1,24 +0,0 @@
-* AVIA HX711 ADC chip for weight cells
- Bit-banging driver
-
-Required properties:
- - compatible: Should be "avia,hx711"
- - sck-gpios: Definition of the GPIO for the clock
- - dout-gpios: Definition of the GPIO for data-out
- See Documentation/devicetree/bindings/gpio/gpio.txt
- - avdd-supply: Definition of the regulator used as analog supply
-
-Optional properties:
- - clock-frequency: Frequency of PD_SCK in Hz
- Minimum value allowed is 10 kHz because of maximum
- high time of 50 microseconds.
-
-Example:
-weight {
- compatible = "avia,hx711";
- sck-gpios = <&gpio3 10 GPIO_ACTIVE_HIGH>;
- dout-gpios = <&gpio0 7 GPIO_ACTIVE_HIGH>;
- avdd-suppy = <&avdd>;
- clock-frequency = <100000>;
-};
-
diff --git a/Documentation/devicetree/bindings/iio/adc/avia-hx711.yaml b/Documentation/devicetree/bindings/iio/adc/avia-hx711.yaml
new file mode 100644
index 000000000000..8a4100ceeaf2
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/avia-hx711.yaml
@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/iio/adc/avia-hx711.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: AVIA HX711 ADC chip for weight cells
+
+maintainers:
+ - Andreas Klinger <[email protected]>
+
+description: |
+ Bit-banging driver using two GPIOs:
+ - sck-gpio gives a clock to the sensor with 24 cycles for data retrieval
+ and up to 3 cycles for selection of the input channel and gain for the
+ next measurement
+ - dout-gpio is the sensor data the sensor responds to the clock
+
+ Specifications about the driver can be found at:
+ http://www.aviaic.com/ENProducts.aspx
+
+properties:
+ compatible:
+ enum:
+ - avia,hx711
+
+ sck-gpios:
+ description:
+ Definition of the GPIO for the clock (output). In the datasheet it is
+ named PD_SCK
+ maxItems: 1
+
+ dout-gpios:
+ description:
+ Definition of the GPIO for the data-out sent by the sensor in
+ response to the clock (input).
+ See Documentation/devicetree/bindings/gpio/gpio.txt for information
+ on how to specify a consumer gpio.
+ maxItems: 1
+
+ avdd-supply:
+ description:
+ Definition of the regulator used as analog supply
+ maxItems: 1
+
+ clock-frequency:
+ minimum: 20000
+ maximum: 2500000
+ default: 400000
+
+required:
+ - compatible
+ - sck-gpios
+ - dout-gpios
+ - avdd-supply
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ weight {
+ compatible = "avia,hx711";
+ sck-gpios = <&gpio3 10 GPIO_ACTIVE_HIGH>;
+ dout-gpios = <&gpio0 7 GPIO_ACTIVE_HIGH>;
+ avdd-suppy = <&avdd>;
+ clock-frequency = <100000>;
+ };
--
2.11.0

2019-04-02 01:49:11

by Rob Herring

Subject: Re: [PATCH v2] avia-hx711.yaml: transform DT binding to YAML

On Mon, Apr 1, 2019 at 12:34 PM Andreas Klinger <[email protected]> wrote:
>
> replace avia-hx711.txt by avia-hx711.yaml as yaml devicetree
> documentation for avia hx711 iio adc sensor
>
> Signed-off-by: Andreas Klinger <[email protected]>
> ---
> .../devicetree/bindings/iio/adc/avia-hx711.txt | 24 --------
> .../devicetree/bindings/iio/adc/avia-hx711.yaml | 66 ++++++++++++++++++++++
> 2 files changed, 66 insertions(+), 24 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/iio/adc/avia-hx711.txt
> create mode 100644 Documentation/devicetree/bindings/iio/adc/avia-hx711.yaml

Reviewed-by: Rob Herring <[email protected]>

2019-04-07 11:22:49

by Jonathan Cameron

Subject: Re: [PATCH v2] avia-hx711.yaml: transform DT binding to YAML

On Mon, 1 Apr 2019 20:47:19 -0500
Rob Herring <[email protected]> wrote:

> On Mon, Apr 1, 2019 at 12:34 PM Andreas Klinger <[email protected]> wrote:
> >
> > replace avia-hx711.txt by avia-hx711.yaml as yaml devicetree
> > documentation for avia hx711 iio adc sensor
> >
> > Signed-off-by: Andreas Klinger <[email protected]>
Applied to the togreg branch of iio.git and pushed out as testing.

Thanks,

Jonathan

> > ---
> > .../devicetree/bindings/iio/adc/avia-hx711.txt | 24 --------
> > .../devicetree/bindings/iio/adc/avia-hx711.yaml | 66 ++++++++++++++++++++++
> > 2 files changed, 66 insertions(+), 24 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/iio/adc/avia-hx711.txt
> > create mode 100644 Documentation/devicetree/bindings/iio/adc/avia-hx711.yaml
>
> Reviewed-by: Rob Herring <[email protected]>