Re: [PATCH] dt-bindings: gpio: gpio-davinci: Convert to json-schema

From: Rob Herring
Date: Mon May 17 2021 - 18:15:21 EST

Next message: Sean Anderson: "Re: [PATCH v3 2/2] clocksource: Add support for Xilinx AXI Timer"
Previous message: Pavel Begunkov: "Re: [PATCH] signal: optimise signal_pending()"
Next in thread: Aswath Govindraju: "Re: [PATCH] dt-bindings: gpio: gpio-davinci: Convert to json-schema"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

On Tue, May 11, 2021 at 02:31:20PM +0530, Aswath Govindraju wrote:
> Convert gpio-davinci dt-binding documentation from txt to yaml format.
>
> Signed-off-by: Aswath Govindraju <a-govindraju@xxxxxx>
> ---
> .../devicetree/bindings/gpio/gpio-davinci.txt | 167 ---------------
> .../bindings/gpio/gpio-davinci.yaml | 193 ++++++++++++++++++
> MAINTAINERS | 2 +-
> 3 files changed, 194 insertions(+), 168 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/gpio/gpio-davinci.txt
> create mode 100644 Documentation/devicetree/bindings/gpio/gpio-davinci.yaml
>
> diff --git a/Documentation/devicetree/bindings/gpio/gpio-davinci.txt b/Documentation/devicetree/bindings/gpio/gpio-davinci.txt
> deleted file mode 100644
> index 696ea46227d1..000000000000
> --- a/Documentation/devicetree/bindings/gpio/gpio-davinci.txt
> +++ /dev/null
> @@ -1,167 +0,0 @@
> -Davinci/Keystone GPIO controller bindings
> -
> -Required Properties:
> -- compatible: should be "ti,dm6441-gpio": for Davinci da850 SoCs
> - "ti,keystone-gpio": for Keystone 2 66AK2H/K, 66AK2L,
> - 66AK2E SoCs
> - "ti,k2g-gpio", "ti,keystone-gpio": for 66AK2G
> - "ti,am654-gpio", "ti,keystone-gpio": for TI K3 AM654
> - "ti,j721e-gpio", "ti,keystone-gpio": for J721E SoCs
> - "ti,am64-gpio", "ti,keystone-gpio": for AM64 SoCs
> -
> -- reg: Physical base address of the controller and the size of memory mapped
> - registers.
> -
> -- gpio-controller : Marks the device node as a gpio controller.
> -
> -- #gpio-cells : Should be two.
> - - first cell is the pin number
> - - second cell is used to specify optional parameters (unused)
> -
> -- interrupts: Array of GPIO interrupt number. Only banked or unbanked IRQs are
> - supported at a time.
> -
> -- ti,ngpio: The number of GPIO pins supported.
> -
> -- ti,davinci-gpio-unbanked: The number of GPIOs that have an individual interrupt
> - line to processor.
> -
> -- clocks: Should contain the device's input clock, and should be defined as per
> - the appropriate clock bindings consumer usage in,
> -
> - Documentation/devicetree/bindings/clock/keystone-gate.txt
> - for 66AK2HK/66AK2L/66AK2E SoCs or,
> -
> - Documentation/devicetree/bindings/clock/ti,sci-clk.txt
> - for 66AK2G SoCs
> -
> -- clock-names: Name should be "gpio";
> -
> -Currently clock-names and clocks are needed for all keystone 2 platforms
> -Davinci platforms do not have DT clocks as of now.
> -
> -The GPIO controller also acts as an interrupt controller. It uses the default
> -two cells specifier as described in Documentation/devicetree/bindings/
> -interrupt-controller/interrupts.txt.
> -
> -Example:
> -
> -gpio: gpio@1e26000 {
> - compatible = "ti,dm6441-gpio";
> - gpio-controller;
> - #gpio-cells = <2>;
> - reg = <0x226000 0x1000>;
> - interrupt-parent = <&intc>;
> - interrupts = <42 IRQ_TYPE_EDGE_BOTH 43 IRQ_TYPE_EDGE_BOTH
> - 44 IRQ_TYPE_EDGE_BOTH 45 IRQ_TYPE_EDGE_BOTH
> - 46 IRQ_TYPE_EDGE_BOTH 47 IRQ_TYPE_EDGE_BOTH
> - 48 IRQ_TYPE_EDGE_BOTH 49 IRQ_TYPE_EDGE_BOTH
> - 50 IRQ_TYPE_EDGE_BOTH>;
> - ti,ngpio = <144>;
> - ti,davinci-gpio-unbanked = <0>;
> - interrupt-controller;
> - #interrupt-cells = <2>;
> -};
> -
> -leds {
> - compatible = "gpio-leds";
> -
> - led1 {
> - label = "davinci:green:usr1";
> - gpios = <&gpio 10 GPIO_ACTIVE_HIGH>;
> - ...
> - };
> -
> - led2 {
> - label = "davinci:red:debug1";
> - gpios = <&gpio 11 GPIO_ACTIVE_HIGH>;
> - ...
> - };
> -};
> -
> -Example for 66AK2G:
> -
> -gpio0: gpio@2603000 {
> - compatible = "ti,k2g-gpio", "ti,keystone-gpio";
> - reg = <0x02603000 0x100>;
> - gpio-controller;
> - #gpio-cells = <2>;
> - interrupts = <GIC_SPI 432 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 433 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 434 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 435 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 436 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 437 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 438 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 439 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 440 IRQ_TYPE_EDGE_RISING>;
> - interrupt-controller;
> - #interrupt-cells = <2>;
> - ti,ngpio = <144>;
> - ti,davinci-gpio-unbanked = <0>;
> - clocks = <&k2g_clks 0x001b 0x0>;
> - clock-names = "gpio";
> -};
> -
> -Example for 66AK2HK/66AK2L/66AK2E:
> -
> -gpio0: gpio@260bf00 {
> - compatible = "ti,keystone-gpio";
> - reg = <0x0260bf00 0x100>;
> - gpio-controller;
> - #gpio-cells = <2>;
> - /* HW Interrupts mapped to GPIO pins */
> - interrupts = <GIC_SPI 120 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 121 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 122 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 123 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 124 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 125 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 126 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 127 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 128 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 129 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 130 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 131 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 132 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 133 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 134 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 135 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 136 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 137 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 138 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 139 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 140 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 141 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 142 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 143 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 144 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 145 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 146 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 147 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 148 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 149 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 150 IRQ_TYPE_EDGE_RISING>,
> - <GIC_SPI 151 IRQ_TYPE_EDGE_RISING>;
> - clocks = <&clkgpio>;
> - clock-names = "gpio";
> - ti,ngpio = <32>;
> - ti,davinci-gpio-unbanked = <32>;
> -};
> -
> -Example for K3 AM654:
> -
> -wkup_gpio0: wkup_gpio0@42110000 {
> - compatible = "ti,am654-gpio", "ti,keystone-gpio";
> - reg = <0x42110000 0x100>;
> - gpio-controller;
> - #gpio-cells = <2>;
> - interrupt-parent = <&intr_wkup_gpio>;
> - interrupts = <59 128>, <59 129>, <59 130>, <59 131>;
> - interrupt-controller;
> - #interrupt-cells = <2>;
> - ti,ngpio = <56>;
> - ti,davinci-gpio-unbanked = <0>;
> - clocks = <&k3_clks 59 0>;
> - clock-names = "gpio";
> -};
> diff --git a/Documentation/devicetree/bindings/gpio/gpio-davinci.yaml b/Documentation/devicetree/bindings/gpio/gpio-davinci.yaml
> new file mode 100644
> index 000000000000..1e16172669c7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/gpio/gpio-davinci.yaml
> @@ -0,0 +1,193 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/gpio/gpio-davinci.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: GPIO controller for Davinci and keystone devices
> +
> +maintainers:
> + - Keerthy <j-keerthy@xxxxxx>
> +
> +properties:
> + compatible:
> + oneOf:
> + - items:
> + - enum:
> + - ti,k2g-gpio
> + - ti,am654-gpio
> + - ti,j721e-gpio
> + - ti,am64-gpio
> + - const: ti,keystone-gpio
> +
> + - items:
> + - const: ti,dm6441-gpio
> + - items:
> + - const: ti,keystone-gpio

These 2 can be expressed as an 'enum'.

> +
> + reg:
> + maxItems: 1
> + description:
> + Physical base address of the controller and the size of memory mapped registers.

Drop. That's every 'reg' property.

> +
> + gpio-controller: true
> +
> + gpio-ranges: true
> +
> + gpio-line-names:
> + description: strings describing the names of each gpio line.

Any constraints like min/max number of lines?

> +
> + "#gpio-cells":
> + const: 2
> + description:
> + first cell is the pin number and second cell is used to specify optional parameters (unused).
> +
> + interrupts:
> + description:
> + Array of GPIO interrupt number. Only banked or unbanked IRQs are supported at a time.

Needs constraints. How many items and what are they?

> +
> + ti,ngpio:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: The number of GPIO pins supported consecutively.
> + minimum: 1
> +
> + ti,davinci-gpio-unbanked:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: The number of GPIOs that have an individual interrupt line to processor.
> + minimum: 0
> +
> + clocks:
> + maxItems: 1
> + description:
> + clock-specifier to represent input to the GPIO controller.

Drop description.

> +
> + clock-names:
> + const: gpio
> +
> + interrupt-controller: true
> +
> + power-domains:
> + maxItems: 1
> + description:
> + Phandle to the power domain provider node.

Drop.

> +
> + "#interrupt-cells":
> + const: 2
> +
> +patternProperties:
> + "-hog$":
> + type: object
> + properties:
> + gpios: true
> + gpio-hog: true
> + input: true
> + output-high: true
> + output-low: true
> + line-name: true
> +
> + required:
> + - gpio-hog
> + - gpios
> +
> +required:
> + - compatible
> + - reg
> + - gpio-controller
> + - "#gpio-cells"
> + - interrupts
> + - ti,ngpio
> + - ti,davinci-gpio-unbanked
> + - clocks
> + - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include<dt-bindings/interrupt-controller/arm-gic.h>
> +
> + gpio0: gpio@2603000 {
> + compatible = "ti,k2g-gpio", "ti,keystone-gpio";
> + reg = <0x02603000 0x100>;
> + gpio-controller;
> + #gpio-cells = <2>;
> + interrupts = <GIC_SPI 432 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 433 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 434 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 435 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 436 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 437 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 438 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 439 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 440 IRQ_TYPE_EDGE_RISING>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + ti,ngpio = <144>;
> + ti,davinci-gpio-unbanked = <0>;
> + clocks = <&k2g_clks 0x001b 0x0>;
> + clock-names = "gpio";
> + };
> +
> + - |
> + #include<dt-bindings/interrupt-controller/arm-gic.h>
> +
> + gpio1: gpio@260bf00 {
> + compatible = "ti,keystone-gpio";
> + reg = <0x0260bf00 0x100>;
> + gpio-controller;
> + #gpio-cells = <2>;
> + /* HW Interrupts mapped to GPIO pins */
> + interrupts = <GIC_SPI 120 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 121 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 122 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 123 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 124 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 125 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 126 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 127 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 128 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 129 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 130 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 131 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 132 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 133 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 134 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 135 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 136 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 137 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 138 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 139 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 140 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 141 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 142 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 143 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 144 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 145 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 146 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 147 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 148 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 149 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 150 IRQ_TYPE_EDGE_RISING>,
> + <GIC_SPI 151 IRQ_TYPE_EDGE_RISING>;
> + clocks = <&clkgpio>;
> + clock-names = "gpio";
> + ti,ngpio = <32>;
> + ti,davinci-gpio-unbanked = <32>;
> + };
> +
> + - |
> + wkup_gpio0: wkup_gpio0@42110000 {

gpio@...

> + compatible = "ti,am654-gpio", "ti,keystone-gpio";
> + reg = <0x42110000 0x100>;
> + gpio-controller;
> + #gpio-cells = <2>;
> + interrupt-parent = <&intr_wkup_gpio>;
> + interrupts = <60>, <61>, <62>, <63>;
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + ti,ngpio = <56>;
> + ti,davinci-gpio-unbanked = <0>;
> + clocks = <&k3_clks 59 0>;
> + clock-names = "gpio";
> + };
> +
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 6e183abbbd2e..6b3519db8085 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -18269,7 +18269,7 @@ TI DAVINCI SERIES GPIO DRIVER
> M: Keerthy <j-keerthy@xxxxxx>
> L: linux-gpio@xxxxxxxxxxxxxxx
> S: Maintained
> -F: Documentation/devicetree/bindings/gpio/gpio-davinci.txt
> +F: Documentation/devicetree/bindings/gpio/gpio-davinci.yaml
> F: drivers/gpio/gpio-davinci.c
>
> TI DAVINCI SERIES MEDIA DRIVER
> --
> 2.17.1
>

Next message: Sean Anderson: "Re: [PATCH v3 2/2] clocksource: Add support for Xilinx AXI Timer"
Previous message: Pavel Begunkov: "Re: [PATCH] signal: optimise signal_pending()"
Next in thread: Aswath Govindraju: "Re: [PATCH] dt-bindings: gpio: gpio-davinci: Convert to json-schema"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]