Re: [PATCH] dt-bindings: gpio: gpio-xilinx: Convert Xilinx axi gpio binding to YAML

From: Rob Herring
Date: Tue Aug 09 2022 - 16:37:16 EST

On Tue, Aug 09, 2022 at 06:38:42PM +0530, Srinivas Neeli wrote:
> Convert Xilinx axi gpio binding documentation to YAML.
>
> Signed-off-by: Srinivas Neeli <srinivas.neeli@xxxxxxxxxx>
> ---
> .../devicetree/bindings/gpio/gpio-xilinx.txt | 48 ------
> .../bindings/gpio/xlnx,gpio-xilinx.yaml | 140 ++++++++++++++++++
> 2 files changed, 140 insertions(+), 48 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/gpio/gpio-xilinx.txt
> create mode 100644 Documentation/devicetree/bindings/gpio/xlnx,gpio-xilinx.yaml
>
> diff --git a/Documentation/devicetree/bindings/gpio/gpio-xilinx.txt b/Documentation/devicetree/bindings/gpio/gpio-xilinx.txt
> deleted file mode 100644
> index e506f30e1a95..000000000000
> --- a/Documentation/devicetree/bindings/gpio/gpio-xilinx.txt
> +++ /dev/null
> @@ -1,48 +0,0 @@
> -Xilinx plb/axi GPIO controller
> -
> -Dual channel GPIO controller with configurable number of pins
> -(from 1 to 32 per channel). Every pin can be configured as
> -input/output/tristate. Both channels share the same global IRQ but
> -local interrupts can be enabled on channel basis.
> -
> -Required properties:
> -- compatible : Should be "xlnx,xps-gpio-1.00.a"
> -- reg : Address and length of the register set for the device
> -- #gpio-cells : Should be two. The first cell is the pin number and the
> - second cell is used to specify optional parameters (currently unused).
> -- gpio-controller : Marks the device node as a GPIO controller.
> -
> -Optional properties:
> -- clocks : Input clock specifier. Refer to common clock bindings.
> -- interrupts : Interrupt mapping for GPIO IRQ.
> -- xlnx,all-inputs : if n-th bit is setup, GPIO-n is input
> -- xlnx,dout-default : if n-th bit is 1, GPIO-n default value is 1
> -- xlnx,gpio-width : gpio width
> -- xlnx,tri-default : if n-th bit is 1, GPIO-n is in tristate mode
> -- xlnx,is-dual : if 1, controller also uses the second channel
> -- xlnx,all-inputs-2 : as above but for the second channel
> -- xlnx,dout-default-2 : as above but the second channel
> -- xlnx,gpio2-width : as above but for the second channel
> -- xlnx,tri-default-2 : as above but for the second channel
> -
> -
> -Example:
> -gpio: gpio@40000000 {
> - #gpio-cells = <2>;
> - compatible = "xlnx,xps-gpio-1.00.a";
> - clocks = <&clkc25>;
> - gpio-controller ;
> - interrupt-parent = <&microblaze_0_intc>;
> - interrupts = < 6 2 >;
> - reg = < 0x40000000 0x10000 >;
> - xlnx,all-inputs = <0x0>;
> - xlnx,all-inputs-2 = <0x0>;
> - xlnx,dout-default = <0x0>;
> - xlnx,dout-default-2 = <0x0>;
> - xlnx,gpio-width = <0x2>;
> - xlnx,gpio2-width = <0x2>;
> - xlnx,interrupt-present = <0x1>;
> - xlnx,is-dual = <0x1>;
> - xlnx,tri-default = <0xffffffff>;
> - xlnx,tri-default-2 = <0xffffffff>;
> -} ;
> diff --git a/Documentation/devicetree/bindings/gpio/xlnx,gpio-xilinx.yaml b/Documentation/devicetree/bindings/gpio/xlnx,gpio-xilinx.yaml
> new file mode 100644
> index 000000000000..089e297aa530
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/gpio/xlnx,gpio-xilinx.yaml
> @@ -0,0 +1,140 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/gpio/xlnx,gpio-xilinx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx Axi GPIO controller Device Tree Bindings

AXI

Drop 'Device Tree Bindings'

> +
> +maintainers:
> + - Neeli Srinivas <srinivas.neeli@xxxxxxx>

Which is the right name? This or your S-o-b/author?

> +
> +description:
> + The AXI GPIO design provides a general purpose input/output interface
> + to an AXI4-Lite interface. The AXI GPIO can be configured as either
> + a single or a dual-channel device. The width of each channel is
> + independently configurable. The channels can be configured to
> + generate an interrupt when a transition on any of their inputs occurs.
> +
> +properties:
> + compatible:
> + enum:
> + - xlnx,xps-gpio-1.00.a
> + reg:
> + maxItems: 1
> +
> + "#gpio-cells":
> + const: 2
> +
> + interrupts:
> + maxItems: 1
> +
> + gpio-controller: true
> +
> + gpio-line-names:
> + description: strings describing the names of each gpio line
> + minItems: 1
> + maxItems: 64
> +
> + interrupt-controller: true
> +
> + "#interrupt-cells":
> + const: 2
> +
> + clocks:
> + maxItems: 1
> +
> + interrupt-names: true
> +
> + xlnx,all-inputs:
> + $ref: "/schemas/types.yaml#/definitions/uint32"

Don't need quotes.

> + description: This option sets this GPIO channel1 bits in input mode.
> +
> + xlnx,all-inputs-2:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: This option sets this GPIO channel2 bits in input mode.
> +
> + xlnx,all-outputs:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: This option sets this GPIO channel1 bits in output mode.
> +
> + xlnx,all-outputs-2:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: This option sets this GPIO channel2 bits in output mode.
> +
> + xlnx,dout-default:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: Sets the default value of all the enabled bits of
> + channel1. By default, this parameter is set to 0x0.

default: 0

> +
> + xlnx,dout-default-2:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: Sets the default value of all the enabled bits of
> + channel2. By default, this parameter is set to 0x0.

default: 0

> +
> + xlnx,gpio-width:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: The value defines the bit width of the GPIO channel1.
> + Its value can be from 1 to 32, and default value is 32.

Express as constraints instead:

minimum: 1
maximum: 32
default: 32

> +
> + xlnx,gpio2-width:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: The value defines the bit width of the GPIO channel2.
> + Its value can be from 1 to 32, and default value is 32.
> +
> + xlnx,interrupt-present:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: This parameter enables interrupt control logic
> + and interrupt registers in GPIO module. By default it is 0.

blank line

Constraints? Only 0 or 1?

> + xlnx,is-dual:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: This parameter enables a second GPIO channel (GPIO2).

Constraints?

> +
> + xlnx,tri-default:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: This value configures the input or output mode
> + of each bit of GPIO channel1.
> +
> + xlnx,tri-default-2:
> + $ref: "/schemas/types.yaml#/definitions/uint32"
> + description: This value configures the input or output mode
> + of each bit of GPIO channel2.
> +
> +required:
> + - reg
> + - compatible
> + - gpio-controller
> + - "#gpio-cells"
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> + gpio@e000a000 {
> + #gpio-cells = <2>;
> + #interrupt-cells = <0x2>;
> + clocks = <&zynqmp_clk 71>;
> + compatible = "xlnx,xps-gpio-1.00.a";
> + gpio-controller;
> + interrupt-controller;
> + interrupt-names = "ip2intc_irpt";
> + interrupt-parent = <&gic>;
> + interrupts = <0 89 4>;
> + reg = <0xa0020000 0x10000>;

Normal order is 'compatible' first, then 'reg', then everything else.

> + xlnx,all-inputs = <0x0>;
> + xlnx,all-inputs-2 = <0x0>;
> + xlnx,all-outputs = <0x0>;
> + xlnx,all-outputs-2 = <0x0>;
> + xlnx,dout-default = <0x0>;
> + xlnx,dout-default-2 = <0x0>;
> + xlnx,gpio-width = <0x20>;
> + xlnx,gpio2-width = <0x20>;
> + xlnx,interrupt-present = <0x1>;
> + xlnx,is-dual = <0x1>;
> + xlnx,tri-default = <0xFFFFFFFF>;
> + xlnx,tri-default-2 = <0xFFFFFFFF>;
> + };
> +
> +...
> --
> 2.17.1
>
>