| Message ID | 20200514061747.25466-2-fengping.yu@mediatek.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v7,1/3] dt-bindings: Add keypad devicetree documentation | expand |
Hi, On 20-05-14 14:17, Fengping Yu wrote: > From: "fengping.yu" <fengping.yu@mediatek.com> > > Add Mediatek matrix keypad dt-binding doc as yaml schema. > > Signed-off-by: fengping.yu <fengping.yu@mediatek.com> > --- > .../devicetree/bindings/input/mtk-kpd.yaml | 102 ++++++++++++++++++ > 1 file changed, 102 insertions(+) > create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml > > diff --git a/Documentation/devicetree/bindings/input/mtk-kpd.yaml b/Documentation/devicetree/bindings/input/mtk-kpd.yaml > new file mode 100644 > index 000000000000..8f594fe0bfc2 > --- /dev/null > +++ b/Documentation/devicetree/bindings/input/mtk-kpd.yaml > @@ -0,0 +1,102 @@ > +%YAML 1.2 > +--- > +version: 1 > + > +$id: http://devicetree.org/schemas/input/mtk-keypad.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Mediatek's Keypad Controller device tree bindings > + > +maintainer: > + - Fengping Yu <fengping.yu@mediatek.com> > + > +description: | > + Mediatek's Keypad controller is used to interface a SoC with a matrix-type > + keypad device. The keypad controller supports multiple row and column lines. > + A key can be placed at each intersection of a unique row and a unique column. > + The keypad controller can sense a key-press and key-release and report the > + event using a interrupt to the cpu. > + > +properties: > + compatible: > + constraint: | enum or const ? > + "mediatek,mt6779-keypad" > + "mediatek, kp" > + > + clock-names: > + description: Names of the clocks listed in clocks property in the same order > + > + clocks: > + description: Must contain one entry, for the module clock > + refs: devicetree/bindings/clocks/clock-bindings.txt for details. > + > + interrupts: > + description: A single interrupt specifier > + > + linux,keymap: > + description: The keymap for keys as described in the binding document > + refs: devicetree/bindings/input/matrix-keymap.txt > + > + pinctrl-0: > + description: Specify pin control groups used for this controller > + refs: devicetree/bindings/pinctrl/pinctrl-bindings.txt > + > + pinctrl-names: > + description: Names for optional pin modes > + > + reg: > + description: The base address of the Keypad register bank > + > + wakeup-source: > + description: use any event on keypad as wakeup event > + > + keypad,num-columns: > + description: Number of column lines connected to the keypad controller, > + it is not equal to PCB columns number, instead you should add required value > + for each IC > + > + keypad,num-rows: > + description: Number of row lines connected to the keypad controller, it is > + not equal to PCB rows number, instead you should add required value for each IC > + > + mediatek,debounce-us: > + description: Debounce interval in microseconds > + maximum: 256000 I think that you are missing the maxItems on all your properties so we can't make any validation. Also the indent looks wrong. > + > + > +required: > + - compatible > + - reg > + - interrupts > + - mediatek,debounce-us > + - keypad,num-rows > + - keypad,num-columns > + - linux,keymap > + - pinctrl > + - clocks > + - clock-names > + > +optional: > + - wakeup-source: I think the optional can be dropped. > +examples: > + - | > + > + keypad: kp@10010000 { > + compatible = "mediatek,kp"; > + reg = <0 0x10010000 0 0x1000>; > + wakeup-source; > + interrupts = <GIC_SPI 75 IRQ_TYPE_EDGE_FALLING>; > + clocks = <&clk26m>; > + clock-names = "kpd"; > + }; > + > + &keypad { > + mediatek,debounce-us = <32000>; > + keypad,num-rows = <8>; > + keypad,num-columns = <9>; > + linux,keymap = < MATRIX_KEY(0x00, 0x00, KEY_VOLUMEDOWN) >; > + status = "okay"; > + pinctrl-names = "default"; > + pinctrl-0 = <&kpd_gpios_def_cfg>; > + }; Pls squash those nodes. Regards, Marco > -- > 2.18.0
On 14/05/2020 08:17, Fengping Yu wrote: > From: "fengping.yu" <fengping.yu@mediatek.com> > > Add Mediatek matrix keypad dt-binding doc as yaml schema. > > Signed-off-by: fengping.yu <fengping.yu@mediatek.com> > --- > .../devicetree/bindings/input/mtk-kpd.yaml | 102 ++++++++++++++++++ > 1 file changed, 102 insertions(+) > create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml > > diff --git a/Documentation/devicetree/bindings/input/mtk-kpd.yaml b/Documentation/devicetree/bindings/input/mtk-kpd.yaml > new file mode 100644 > index 000000000000..8f594fe0bfc2 > --- /dev/null > +++ b/Documentation/devicetree/bindings/input/mtk-kpd.yaml > @@ -0,0 +1,102 @@ > +%YAML 1.2 > +--- > +version: 1 > + > +$id: http://devicetree.org/schemas/input/mtk-keypad.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Mediatek's Keypad Controller device tree bindings > + > +maintainer: > + - Fengping Yu <fengping.yu@mediatek.com> > + > +description: | > + Mediatek's Keypad controller is used to interface a SoC with a matrix-type > + keypad device. The keypad controller supports multiple row and column lines. > + A key can be placed at each intersection of a unique row and a unique column. > + The keypad controller can sense a key-press and key-release and report the > + event using a interrupt to the cpu. > + > +properties: > + compatible: > + constraint: | > + "mediatek,mt6779-keypad" > + "mediatek, kp" "mediatek, kp" is too generic. Are you aware that the keypad can be used by other SoCs. Then we should add them later with a fallback to mt6779-keypad. Regards, Matthias > + > + clock-names: > + description: Names of the clocks listed in clocks property in the same order > + > + clocks: > + description: Must contain one entry, for the module clock > + refs: devicetree/bindings/clocks/clock-bindings.txt for details. > + > + interrupts: > + description: A single interrupt specifier > + > + linux,keymap: > + description: The keymap for keys as described in the binding document > + refs: devicetree/bindings/input/matrix-keymap.txt > + > + pinctrl-0: > + description: Specify pin control groups used for this controller > + refs: devicetree/bindings/pinctrl/pinctrl-bindings.txt > + > + pinctrl-names: > + description: Names for optional pin modes > + > + reg: > + description: The base address of the Keypad register bank > + > + wakeup-source: > + description: use any event on keypad as wakeup event > + > + keypad,num-columns: > + description: Number of column lines connected to the keypad controller, > + it is not equal to PCB columns number, instead you should add required value > + for each IC > + > + keypad,num-rows: > + description: Number of row lines connected to the keypad controller, it is > + not equal to PCB rows number, instead you should add required value for each IC > + > + mediatek,debounce-us: > + description: Debounce interval in microseconds > + maximum: 256000 > + > + > +required: > + - compatible > + - reg > + - interrupts > + - mediatek,debounce-us > + - keypad,num-rows > + - keypad,num-columns > + - linux,keymap > + - pinctrl > + - clocks > + - clock-names > + > +optional: > + - wakeup-source: > + > +examples: > + - | > + > + keypad: kp@10010000 { > + compatible = "mediatek,kp"; > + reg = <0 0x10010000 0 0x1000>; > + wakeup-source; > + interrupts = <GIC_SPI 75 IRQ_TYPE_EDGE_FALLING>; > + clocks = <&clk26m>; > + clock-names = "kpd"; > + }; > + > + &keypad { > + mediatek,debounce-us = <32000>; > + keypad,num-rows = <8>; > + keypad,num-columns = <9>; > + linux,keymap = < MATRIX_KEY(0x00, 0x00, KEY_VOLUMEDOWN) >; > + status = "okay"; > + pinctrl-names = "default"; > + pinctrl-0 = <&kpd_gpios_def_cfg>; > + }; >
diff --git a/Documentation/devicetree/bindings/input/mtk-kpd.yaml b/Documentation/devicetree/bindings/input/mtk-kpd.yaml new file mode 100644 index 000000000000..8f594fe0bfc2 --- /dev/null +++ b/Documentation/devicetree/bindings/input/mtk-kpd.yaml @@ -0,0 +1,102 @@ +%YAML 1.2 +--- +version: 1 + +$id: http://devicetree.org/schemas/input/mtk-keypad.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Mediatek's Keypad Controller device tree bindings + +maintainer: + - Fengping Yu <fengping.yu@mediatek.com> + +description: | + Mediatek's Keypad controller is used to interface a SoC with a matrix-type + keypad device. The keypad controller supports multiple row and column lines. + A key can be placed at each intersection of a unique row and a unique column. + The keypad controller can sense a key-press and key-release and report the + event using a interrupt to the cpu. + +properties: + compatible: + constraint: | + "mediatek,mt6779-keypad" + "mediatek, kp" + + clock-names: + description: Names of the clocks listed in clocks property in the same order + + clocks: + description: Must contain one entry, for the module clock + refs: devicetree/bindings/clocks/clock-bindings.txt for details. + + interrupts: + description: A single interrupt specifier + + linux,keymap: + description: The keymap for keys as described in the binding document + refs: devicetree/bindings/input/matrix-keymap.txt + + pinctrl-0: + description: Specify pin control groups used for this controller + refs: devicetree/bindings/pinctrl/pinctrl-bindings.txt + + pinctrl-names: + description: Names for optional pin modes + + reg: + description: The base address of the Keypad register bank + + wakeup-source: + description: use any event on keypad as wakeup event + + keypad,num-columns: + description: Number of column lines connected to the keypad controller, + it is not equal to PCB columns number, instead you should add required value + for each IC + + keypad,num-rows: + description: Number of row lines connected to the keypad controller, it is + not equal to PCB rows number, instead you should add required value for each IC + + mediatek,debounce-us: + description: Debounce interval in microseconds + maximum: 256000 + + +required: + - compatible + - reg + - interrupts + - mediatek,debounce-us + - keypad,num-rows + - keypad,num-columns + - linux,keymap + - pinctrl + - clocks + - clock-names + +optional: + - wakeup-source: + +examples: + - | + + keypad: kp@10010000 { + compatible = "mediatek,kp"; + reg = <0 0x10010000 0 0x1000>; + wakeup-source; + interrupts = <GIC_SPI 75 IRQ_TYPE_EDGE_FALLING>; + clocks = <&clk26m>; + clock-names = "kpd"; + }; + + &keypad { + mediatek,debounce-us = <32000>; + keypad,num-rows = <8>; + keypad,num-columns = <9>; + linux,keymap = < MATRIX_KEY(0x00, 0x00, KEY_VOLUMEDOWN) >; + status = "okay"; + pinctrl-names = "default"; + pinctrl-0 = <&kpd_gpios_def_cfg>; + };