Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Tue, 25 Feb 2020 10:10:55 +0100
From:   Maxime Ripard <maxime@cerno.tech>
To:     Mateusz Holenko <mholenko@antmicro.com>
Cc:     Rob Herring <robh+dt@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Jiri Slaby <jslaby@suse.com>, devicetree@vger.kernel.org,
        linux-serial@vger.kernel.org, Stafford Horne <shorne@gmail.com>,
        Karol Gugala <kgugala@antmicro.com>,
        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
        "David S. Miller" <davem@davemloft.net>,
        "Paul E. McKenney" <paulmck@linux.ibm.com>,
        Filip Kokosinski <fkokosinski@antmicro.com>,
        Pawel Czarnecki <pczarnecki@internships.antmicro.com>,
        Joel Stanley <joel@jms.id.au>,
        Jonathan Cameron <Jonathan.Cameron@huawei.com>,
        Shawn Guo <shawnguo@kernel.org>,
        Heiko Stuebner <heiko@sntech.de>,
        Sam Ravnborg <sam@ravnborg.org>,
        Icenowy Zheng <icenowy@aosc.io>,
        Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 2/5] dt-bindings: soc: document LiteX SoC Controller
 bindings
Message-ID: <20200225091055.ubm5r3p6r4ydchyh@gilmour.lan>
References: <20200225094437.4170502-0-mholenko@antmicro.com>
 <20200225094437.4170502-2-mholenko@antmicro.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="7qlwsrkwbcxhj43j"
Content-Disposition: inline
In-Reply-To: <20200225094437.4170502-2-mholenko@antmicro.com>
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk


--7qlwsrkwbcxhj43j
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Hi Mateusz,

On Tue, Feb 25, 2020 at 09:46:45AM +0100, Mateusz Holenko wrote:
> From: Pawel Czarnecki <pczarnecki@internships.antmicro.com>
>
> Add documentation for LiteX SoC Controller bindings.
>
> Signed-off-by: Pawel Czarnecki <pczarnecki@internships.antmicro.com>
> Signed-off-by: Mateusz Holenko <mholenko@antmicro.com>
> ---
>
> Notes:
>     This commit has been introduced in v3 of the patchset.
>
>  .../soc/litex/litex,soc_controller.yaml       | 46 +++++++++++++++++++
>  MAINTAINERS                                   |  6 +++
>  2 files changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml
>
> diff --git a/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml
> new file mode 100644
> index 000000000000..039894265319
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/soc/litex/litex,soc_controller.yaml
> @@ -0,0 +1,46 @@
> +PDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/soc/litex/litex,soc_controller.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LiteX SoC Controller driver
> +
> +description: |
> +  This is the SoC Controller driver for the LiteX SoC Builder.
> +  It's purpose is to verify LiteX CSR (Control&Status Register) access
> +  operations and provide function for other drivers to read/write CSRs
> +  and to check if those accessors are ready to use.
> +
> +maintainers:
> +  - Karol Gugala <kgugala@antmicro.com>
> +  - Mateusz Holenko <mholenko@antmicro.com>
> +
> +properties:
> +  compatible:
> +    const: litex,soc_controller

Usually compatible will use dash as separators, not underscores.

> +  reg:
> +    description: Base address and length of the register space

This is usually removed since it's what's expected from the property
anyway. However, what you should really test for in the number of
address/size couples being set, and you can do that using maxItems: 1

> +  status:
> +    description: |
> +      disables or enables node
> +
> +    const: "okay"

This is added automatically by the tooling, so you can leave it out.

> +required:
> +  - compatible
> +  - reg
> +  - status

And in general, status is not required. Leaving status out is
equivalent to status = "okay"

> +examples:
> +  - |
> +
> +  soc_ctrl0: soc_controller@f0000000 {
> +			compatible = "litex,soc_controller";
> +			reg = <0x0 0xf0000000 0x0 0xC>;
> +			status = "okay";
> +  };

The indentation looks weird here?

Maxime

--7qlwsrkwbcxhj43j
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYIAB0WIQRcEzekXsqa64kGDp7j7w1vZxhRxQUCXlTknwAKCRDj7w1vZxhR
xTU6AQD8Cy+uoGwSrrpsJlekRlGK1bt9y8kmOWrOWFI/wEg4sgEA1FuWrfWI4m9J
4Mg4k4q9o4wFx3JoZnsWCNziqQYXugU=
=agyM
-----END PGP SIGNATURE-----

--7qlwsrkwbcxhj43j--