[v2,2/3] dt-bindings: iio: amplifiers: Add docs for HMC425A Step Attenuator
diff mbox series

Message ID 20200122121702.30494-2-beniamin.bia@analog.com
State Changes Requested
Headers show
Series
  • Untitled series #154662
Related show

Checks

Context Check Description
robh/dt-meta-schema success
robh/checkpatch success

Commit Message

Beniamin Bia Jan. 22, 2020, 12:17 p.m. UTC
From: Michael Hennerich <michael.hennerich@analog.com>

Document support for Analog Devices MC425A Step Attenuator.

Signed-off-by: Michael Hennerich <michael.hennerich@analog.com>
Signed-off-by: Beniamin Bia <beniamin.bia@analog.com>
---
 .../bindings/iio/amplifiers/adi,hmc425a.yaml  | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml

Comments

Rob Herring Jan. 27, 2020, 8:16 p.m. UTC | #1
On Wed, Jan 22, 2020 at 02:17:01PM +0200, Beniamin Bia wrote:
> From: Michael Hennerich <michael.hennerich@analog.com>
> 
> Document support for Analog Devices MC425A Step Attenuator.
> 
> Signed-off-by: Michael Hennerich <michael.hennerich@analog.com>
> Signed-off-by: Beniamin Bia <beniamin.bia@analog.com>
> ---
>  .../bindings/iio/amplifiers/adi,hmc425a.yaml  | 56 +++++++++++++++++++
>  1 file changed, 56 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml b/Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml
> new file mode 100644
> index 000000000000..a0afa661f4ac
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual license new bindings:

(GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/amplifiers/adi,hmc425a.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: HMC425A 6-bit Digital Step Attenuator
> +
> +maintainers:
> +- Michael Hennerich <michael.hennerich@analog.com>
> +- Beniamin Bia <beniamin.bia@analog.com>
> +
> +description: |
> +  Digital Step Attenuator IIO device with gpio interface.
> +  HMC425A 0.5 dB LSB GaAs MMIC 6-BIT DIGITAL POSITIVE CONTROL ATTENUATOR, 2.2 - 8.0 GHz
> +  https://www.analog.com/media/en/technical-documentation/data-sheets/hmc425A.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,hmc425a
> +
> +  vcc-supply:
> +    description:
> +      Digital voltage regulator (see regulator/regulator.txt)
> +    maxItems: 1

All supplies are a single entry, so drop this. Really, 
'vcc-supply: true' is sufficient.

> +
> +  ctrl-gpios:
> +    description:
> +      Must contain an array of 6 GPIO specifiers, referring to the GPIO pins
> +      connected to the control pins V1-V6.
> +    maxItems: 6
> +
> +required:
> +  - compatible
> +  - ctrl-gpios
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    gpio {
> +      #address-cells = <1>;
> +      #size-cells = <0>;

GPIO clients are not child nodes of GPIO controllers, so you can remove 
this node.

> +      gpio_hmc425a: hmc425a {
> +        compatible = "adi,hmc425a";
> +        ctrl-gpios = <&gpio 40 GPIO_ACTIVE_HIGH>,
> +          <&gpio 39 GPIO_ACTIVE_HIGH>,
> +          <&gpio 38 GPIO_ACTIVE_HIGH>,
> +          <&gpio 37 GPIO_ACTIVE_HIGH>,
> +          <&gpio 36 GPIO_ACTIVE_HIGH>,
> +          <&gpio 35 GPIO_ACTIVE_HIGH>;
> +
> +        vcc-supply = <&foo>;
> +      };
> +    };
> +...
> -- 
> 2.17.1
>

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml b/Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml
new file mode 100644
index 000000000000..a0afa661f4ac
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml
@@ -0,0 +1,56 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/amplifiers/adi,hmc425a.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: HMC425A 6-bit Digital Step Attenuator
+
+maintainers:
+- Michael Hennerich <michael.hennerich@analog.com>
+- Beniamin Bia <beniamin.bia@analog.com>
+
+description: |
+  Digital Step Attenuator IIO device with gpio interface.
+  HMC425A 0.5 dB LSB GaAs MMIC 6-BIT DIGITAL POSITIVE CONTROL ATTENUATOR, 2.2 - 8.0 GHz
+  https://www.analog.com/media/en/technical-documentation/data-sheets/hmc425A.pdf
+
+properties:
+  compatible:
+    enum:
+      - adi,hmc425a
+
+  vcc-supply:
+    description:
+      Digital voltage regulator (see regulator/regulator.txt)
+    maxItems: 1
+
+  ctrl-gpios:
+    description:
+      Must contain an array of 6 GPIO specifiers, referring to the GPIO pins
+      connected to the control pins V1-V6.
+    maxItems: 6
+
+required:
+  - compatible
+  - ctrl-gpios
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    gpio {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      gpio_hmc425a: hmc425a {
+        compatible = "adi,hmc425a";
+        ctrl-gpios = <&gpio 40 GPIO_ACTIVE_HIGH>,
+          <&gpio 39 GPIO_ACTIVE_HIGH>,
+          <&gpio 38 GPIO_ACTIVE_HIGH>,
+          <&gpio 37 GPIO_ACTIVE_HIGH>,
+          <&gpio 36 GPIO_ACTIVE_HIGH>,
+          <&gpio 35 GPIO_ACTIVE_HIGH>;
+
+        vcc-supply = <&foo>;
+      };
+    };
+...