Re: [PATCH v2 bus+gpio 2/4] dt-bindings: bus: Document moxtet bus binding

From: Rob Herring
Date: Mon Nov 05 2018 - 17:13:30 EST


On Fri, Nov 02, 2018 at 11:35:37AM +0100, Marek Behún wrote:
> This adds device tree binding documentation for the Moxtet bus, a bus
> via which the different modules connected to the Turris Mox router can
> be configured.
>
> Signed-off-by: Marek Behún <marek.behun@xxxxxx>
> Cc: Rob Herring <robh+dt@xxxxxxxxxx>
> Cc: devicetree@xxxxxxxxxxxxxxx
> ---
> .../devicetree/bindings/bus/moxtet.txt | 34 +++++++++++++++++++
> 1 file changed, 34 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/bus/moxtet.txt
>
> diff --git a/Documentation/devicetree/bindings/bus/moxtet.txt b/Documentation/devicetree/bindings/bus/moxtet.txt
> new file mode 100644
> index 000000000000..19a1bab61e8a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/bus/moxtet.txt
> @@ -0,0 +1,34 @@
> +Turris Mox module configuration bus (over SPI)
> +
> +Required properties:
> + - compatible : Should be "cznic,moxtet".
> + - #address-cells : Has to be 1
> + - #size-cells : Has to be 0
> +For other required and optional properties of SPI slave nodes please refer to
> +../spi/spi-bus.txt.

You need to list what's required. spi-cpol and spi-cpha are typically
required or not.

> +
> +Required properties of subnodes:
> + - reg : Should be position on the Moxtet bus
> +
> +The driver finds the devices connected to the bus by itself, but it may be
> +needed to reference some of them from other parts of the device tree. In that
> +case the devices can be defined as subnodes of the moxtet node.
> +
> +Example:
> +
> + moxtet@1 {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + compatible = "cznic,moxtet";
> + reg = <1>;
> + spi-max-frequency = <10000000>;
> + spi-cpol;
> + spi-cpha;
> +
> + moxtet_sfp: moxtet-sfp@0 {

gpio@0

> + compatible = "cznic,moxtet-sfp";
> + gpio-controller;
> + #gpio-cells = <2>;
> + reg = <0>;
> + }
> + };
> --
> 2.18.1
>