Received-SPF: pass (google.com: domain of linux-kernel+bounces-91226-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Mon, 4 Mar 2024 20:23:27 +0000
From: Conor Dooley <conor@kernel.org>
To: Andrew Jeffery <andrew@codeconstruct.com.au>
Cc: linus.walleij@linaro.org, brgl@bgdev.pl,
	krzysztof.kozlowski+dt@linaro.org, robh+dt@kernel.org,
	conor+dt@kernel.org, joel@jms.id.au, linux-gpio@vger.kernel.org,
	devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
	linux-aspeed@lists.ozlabs.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] dt-bindings: gpio: aspeed,ast2400-gpio: Convert to DT
 schema
Message-ID: <20240304-radio-urban-9843704f374e@spud>
References: <20240226031951.284847-1-andrew@codeconstruct.com.au>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
	protocol="application/pgp-signature"; boundary="WBinYbWIzry76kSg"
Content-Disposition: inline
In-Reply-To: <20240226031951.284847-1-andrew@codeconstruct.com.au>


--WBinYbWIzry76kSg
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Mon, Feb 26, 2024 at 01:49:51PM +1030, Andrew Jeffery wrote:
> Squash warnings such as:
>=20
> ```
> arch/arm/boot/dts/aspeed/aspeed-bmc-facebook-galaxy100.dtb: /ahb/apb@1e60=
0000/gpio@1e780000: failed to match any schema with compatible: ['aspeed,as=
t2400-gpio']
> ```
>=20
> Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
> ---
> v2: Address feedback from Krzysztof:
>     https://lore.kernel.org/all/0d1dd262-b6dd-4d71-9239-8b0aec8cceff@lina=
ro.org/
>=20
> v1: https://lore.kernel.org/all/20240220052918.742793-1-andrew@codeconstr=
uct.com.au/
>=20
>  .../bindings/gpio/aspeed,ast2400-gpio.yaml    | 73 +++++++++++++++++++
>  .../devicetree/bindings/gpio/gpio-aspeed.txt  | 39 ----------
>  2 files changed, 73 insertions(+), 39 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/gpio/aspeed,ast2400=
-gpio.yaml
>  delete mode 100644 Documentation/devicetree/bindings/gpio/gpio-aspeed.txt
>=20
> diff --git a/Documentation/devicetree/bindings/gpio/aspeed,ast2400-gpio.y=
aml b/Documentation/devicetree/bindings/gpio/aspeed,ast2400-gpio.yaml
> new file mode 100644
> index 000000000000..74d376567dfc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/gpio/aspeed,ast2400-gpio.yaml
> @@ -0,0 +1,73 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/gpio/aspeed,ast2400-gpio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Aspeed GPIO controller
> +
> +maintainers:
> +  - Andrew Jeffery <andrew@codeconstruct.com.au>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - aspeed,ast2400-gpio
> +      - aspeed,ast2500-gpio
> +      - aspeed,ast2600-gpio
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +    description: The clock to use for debounce timings

The original binding does not require this clock, but I can't help but
wonder if it should be required. I suspect that this peripheral does
not actually work if a clock is not provided to it. Whether or not the
rate of the clock is then used by the driver for debounce timings or
whatever is a different question.

Otherwise though, this looks fine to me.
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Cheers,
Conor.

> +  "#gpio-cells":
> +    const: 2
> +
> +  gpio-controller: true
> +  gpio-line-names: true
> +  gpio-ranges: true
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  interrupt-controller: true
> +
> +  "#interrupt-cells":
> +    const: 2
> +
> +  ngpios: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-controller
> +  - "#interrupt-cells"
> +  - "#gpio-cells"
> +  - gpio-controller
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            const: aspeed,ast2600-gpio
> +    then:
> +      required:
> +        - ngpios
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    gpio@1e780000 {
> +        compatible =3D "aspeed,ast2400-gpio";
> +        reg =3D <0x1e780000 0x1000>;
> +        interrupts =3D <20>;
> +        interrupt-controller;
> +        #gpio-cells =3D <2>;
> +        gpio-controller;
> +    };
> diff --git a/Documentation/devicetree/bindings/gpio/gpio-aspeed.txt b/Doc=
umentation/devicetree/bindings/gpio/gpio-aspeed.txt
> deleted file mode 100644
> index b2033fc3a71a..000000000000
> --- a/Documentation/devicetree/bindings/gpio/gpio-aspeed.txt
> +++ /dev/null
> @@ -1,39 +0,0 @@
> -Aspeed GPIO controller Device Tree Bindings
> --------------------------------------------
> -
> -Required properties:
> -- compatible		: Either "aspeed,ast2400-gpio", "aspeed,ast2500-gpio",
> -					or "aspeed,ast2600-gpio".
> -
> -- #gpio-cells 		: Should be two
> -			  - First cell is the GPIO line number
> -			  - Second cell is used to specify optional
> -			    parameters (unused)
> -
> -- reg			: Address and length of the register set for the device
> -- gpio-controller	: Marks the device node as a GPIO controller.
> -- interrupts		: Interrupt specifier (see interrupt bindings for
> -			  details)
> -- interrupt-controller	: Mark the GPIO controller as an interrupt-contro=
ller
> -
> -Optional properties:
> -
> -- clocks		: A phandle to the clock to use for debounce timings
> -- ngpios		: Number of GPIOs controlled by this controller. Should	be set
> -				  when there are multiple GPIO controllers on a SoC (ast2600).
> -
> -The gpio and interrupt properties are further described in their respect=
ive
> -bindings documentation:
> -
> -- Documentation/devicetree/bindings/gpio/gpio.txt
> -- Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
> -
> -  Example:
> -	gpio@1e780000 {
> -		#gpio-cells =3D <2>;
> -		compatible =3D "aspeed,ast2400-gpio";
> -		gpio-controller;
> -		interrupts =3D <20>;
> -		reg =3D <0x1e780000 0x1000>;
> -		interrupt-controller;
> -	};
> --=20
> 2.39.2
>=20

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

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

iHUEABYIAB0WIQRh246EGq/8RLhDjO14tDGHoIJi0gUCZeYtvwAKCRB4tDGHoIJi
0sA/AQC/NSqxk+gOMc2YKFuxBEmSMAC+J4rmo8SMcdjAjYJccwD8DNJO0vzMwQ7l
7ZJZiqqGTf2fmGaQkS/nuX0wdNesOQ0=
=jXZ8
-----END PGP SIGNATURE-----

--WBinYbWIzry76kSg--