Re: [PATCH 2/3] dt-bindings: iio: amplifiers: Add docs for HMC425A Step Attenuator

From: Rob Herring
Date: Mon Jan 13 2020 - 15:41:34 EST


On Mon, Jan 13, 2020 at 8:14 AM Beniamin Bia <beniamin.bia@xxxxxxxxxx> wrote:
>
> From: Michael Hennerich <michael.hennerich@xxxxxxxxxx>
>
> Document support for Analog Devices MC425A Step Attenuator.
>
> Signed-off-by: Michael Hennerich <michael.hennerich@xxxxxxxxxx>
> Signed-off-by: Beniamin Bia <beniamin.bia@xxxxxxxxxx>
> ---
> .../bindings/iio/amplifiers/adi,hmc425a.yaml | 55 +++++++++++++++++++
> 1 file changed, 55 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml

Check your bindings with 'make dt_binding_check'. It fails:

Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml:
while scanning a simple key
in "<unicode string>", line 24, column 5
could not find expected ':'
in "<unicode string>", line 25, column 5

>
> 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..6f4a292395e4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/amplifiers/adi,hmc425a.yaml
> @@ -0,0 +1,55 @@
> +# 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@xxxxxxxxxx>
> +
> +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

nit: this should be indented 2 more spaces.

Or use 'const' instead if there's not more similar parts.

> +
> +vcc-supply:
> + description:
> + digital voltage regulator (see regulator/regulator.txt)

Text must be indented under the key.

> + 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>;
> + };
> + }
> --
> 2.17.1
>