| Message ID | 20170125185207.23902-3-paul@crapouillou.net (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Wed, Jan 25, 2017 at 07:51:55PM +0100, Paul Cercueil wrote: > This commit adds documentation for the devicetree bidings of the s/biding/bindings/ > pinctrl-gpio driver, which handles GPIOs of the Ingenic SoCs > currently supported by the Linux kernel. The subject makes no reference that this binding is for Ingenic GPIO. Also, drop the "Documentation: " part. It's redundant. > > Signed-off-by: Paul Cercueil <paul@crapouillou.net> > --- > .../devicetree/bindings/gpio/ingenic,gpio.txt | 45 ++++++++++++++++++++++ > 1 file changed, 45 insertions(+) > create mode 100644 Documentation/devicetree/bindings/gpio/ingenic,gpio.txt > > v2: New patch > v3: No changes > > diff --git a/Documentation/devicetree/bindings/gpio/ingenic,gpio.txt b/Documentation/devicetree/bindings/gpio/ingenic,gpio.txt > new file mode 100644 > index 000000000000..b2eb20494365 > --- /dev/null > +++ b/Documentation/devicetree/bindings/gpio/ingenic,gpio.txt > @@ -0,0 +1,45 @@ > +Ingenic jz47xx GPIO controller > + > +Required properties: > + - compatible: > + - "ingenic,jz4740-gpio" for the JZ4740 SoC > + - "ingenic,jz4780-gpio" for the JZ4780 SoC > + > + - reg: Base address and length of each memory resource used by the GPIO > + controller hardware module. > + > + - gpio-controller: Marks the device node as a GPIO controller. > + - #gpio-cells: Should be 2. The first cell is the GPIO number and the second > + cell specifies GPIO flags, as defined in <dt-bindings/gpio/gpio.h>. Only the > + GPIO_ACTIVE_HIGH and GPIO_ACTIVE_LOW flags are supported. > + - gpio-ranges: Range of pins managed by the GPIO controller. > + > +Optional properties: > + - base: The GPIO number to use as the base for this driver. Drop this please. This is a Linuxism. > + - interrupt-controller: Marks the device node as an interrupt controller. > + - interrupts: Interrupt specifier for the controllers interrupt. > + Required if 'interrupt-controller' is specified. Some h/w doesn't have interrupt capability? If not, this should not be optional. > + > +Please refer to gpio.txt in this directory for details of gpio-ranges property > +and the common GPIO bindings used by client devices. > + > +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. Just document #interrupt-cells and its value and drop this paragraph. > + > +Example: > + > +gpa: gpio-controller@10010000 { > + compatible = "ingenic,jz4740-gpio"; > + reg = <0x10010000 0x100>; > + > + gpio-controller; > + gpio-ranges = <&pinctrl 0 0 32>; > + #gpio-cells = <2>; > + > + interrupt-controller; > + #interrupt-cells = <2>; > + > + interrupt-parent = <&intc>; > + interrupts = <28>; > +}; > -- > 2.11.0 > -- To unsubscribe from this list: send the line "unsubscribe linux-mmc" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
diff --git a/Documentation/devicetree/bindings/gpio/ingenic,gpio.txt b/Documentation/devicetree/bindings/gpio/ingenic,gpio.txt new file mode 100644 index 000000000000..b2eb20494365 --- /dev/null +++ b/Documentation/devicetree/bindings/gpio/ingenic,gpio.txt @@ -0,0 +1,45 @@ +Ingenic jz47xx GPIO controller + +Required properties: + - compatible: + - "ingenic,jz4740-gpio" for the JZ4740 SoC + - "ingenic,jz4780-gpio" for the JZ4780 SoC + + - reg: Base address and length of each memory resource used by the GPIO + controller hardware module. + + - gpio-controller: Marks the device node as a GPIO controller. + - #gpio-cells: Should be 2. The first cell is the GPIO number and the second + cell specifies GPIO flags, as defined in <dt-bindings/gpio/gpio.h>. Only the + GPIO_ACTIVE_HIGH and GPIO_ACTIVE_LOW flags are supported. + - gpio-ranges: Range of pins managed by the GPIO controller. + +Optional properties: + - base: The GPIO number to use as the base for this driver. + - interrupt-controller: Marks the device node as an interrupt controller. + - interrupts: Interrupt specifier for the controllers interrupt. + Required if 'interrupt-controller' is specified. + +Please refer to gpio.txt in this directory for details of gpio-ranges property +and the common GPIO bindings used by client devices. + +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: + +gpa: gpio-controller@10010000 { + compatible = "ingenic,jz4740-gpio"; + reg = <0x10010000 0x100>; + + gpio-controller; + gpio-ranges = <&pinctrl 0 0 32>; + #gpio-cells = <2>; + + interrupt-controller; + #interrupt-cells = <2>; + + interrupt-parent = <&intc>; + interrupts = <28>; +};
This commit adds documentation for the devicetree bidings of the pinctrl-gpio driver, which handles GPIOs of the Ingenic SoCs currently supported by the Linux kernel. Signed-off-by: Paul Cercueil <paul@crapouillou.net> --- .../devicetree/bindings/gpio/ingenic,gpio.txt | 45 ++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 Documentation/devicetree/bindings/gpio/ingenic,gpio.txt v2: New patch v3: No changes