Documentation/devicetree/bindings/iio/adc/avia-hx711.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: "http://devicetree.org/schemas/iio/adc/avia-hx711.yaml#"
   5 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
   6
   7 title: AVIA HX711 ADC chip for weight cells
   8
   9 maintainers:
  10   - Andreas Klinger <ak@it-klinger.de>
  11
  12 description: |
  13   Bit-banging driver using two GPIOs:
  14   - sck-gpio gives a clock to the sensor with 24 cycles for data retrieval
  15     and up to 3 cycles for selection of the input channel and gain for the
  16     next measurement
  17   - dout-gpio is the sensor data the sensor responds to the clock
  18
  19   Specifications about the driver can be found at:
  20   http://www.aviaic.com/ENProducts.aspx
  21
  22 properties:
  23   compatible:
  24     enum:
  25       - avia,hx711
  26
  27   sck-gpios:
  28     description:
  29       Definition of the GPIO for the clock (output). In the datasheet it is
  30       named PD_SCK
  31     maxItems: 1
  32
  33   dout-gpios:
  34     description:
  35       Definition of the GPIO for the data-out sent by the sensor in
  36       response to the clock (input).
  37       See Documentation/devicetree/bindings/gpio/gpio.txt for information
  38       on how to specify a consumer gpio.
  39     maxItems: 1
  40
  41   avdd-supply:
  42     description:
  43       Definition of the regulator used as analog supply
  44
  45   clock-frequency:
  46     minimum: 20000
  47     maximum: 2500000
  48     default: 400000
  49
  50 required:
  51   - compatible
  52   - sck-gpios
  53   - dout-gpios
  54   - avdd-supply
  55
  56 additionalProperties: false
  57
  58 examples:
  59   - |
  60     #include <dt-bindings/gpio/gpio.h>
  61     weight {
  62         compatible = "avia,hx711";
  63         sck-gpios = <&gpio3 10 GPIO_ACTIVE_HIGH>;
  64         dout-gpios = <&gpio0 7 GPIO_ACTIVE_HIGH>;
  65         avdd-supply = <&avdd>;
  66         clock-frequency = <100000>;
  67     };