Skip to contentSkip to conversation

Add matrix keypad driver support for Mediatek SoCs

PATCH Superseded Fengping Yu 3 participants 6 messages Aug 10, 2020 – Aug 13, 2020

Subsystems (4)

v17 of 18 Superseded Latest is v18 →

lore
Share & tools
lore
#0 lore raw

PATCH v17 1/1 Add matrix keypad driver support for Mediatek SoCs

Change since v16:
- list clock-names in devicetree binding documentation
- remove pinctrl in binding documentation
- add default value for keypad,num-columns and keypad,num-rows

fengping.yu (3):
dt-bindings: Add bindings for Mediatek matrix keypad
drivers: input: keyboard: Add mtk keypad driver
configs: defconfig: Add CONFIG_KEYBOARD_MTK_KPD=m

 .../devicetree/bindings/input/mtk-kpd.yaml    |  87 ++++++++
 arch/arm64/configs/defconfig                  |   1 +
 drivers/input/keyboard/Kconfig                |  11 +
 drivers/input/keyboard/Makefile               |   1 +
 drivers/input/keyboard/mtk-kpd.c              | 209 ++++++++++++++++++
 5 files changed, 309 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml
 create mode 100644 drivers/input/keyboard/mtk-kpd.c

--
2.18.0

_______________________________________________
Linux-mediatek mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-mediatek

#1 lore raw

PATCH v17 1/3 dt-bindings: Add bindings for Mediatek matrix keypad

From: "fengping.yu" <[email protected]>

This patch add devicetree bindings for Mediatek matrix keypad driver.

---
 .../devicetree/bindings/input/mtk-kpd.yaml    | 87 +++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +87 -0
new file mode 100644
index 000000000000..d74dd8a6fbde
@@ -0,0 +1,87 @@
+# SPDX-License-Identifier: GPL-2.0
+%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 <[email protected]>
+
+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:
+    oneOf:
+      - const: "mediatek,mt6779-keypad"
+      - const: "mediatek,mt6873-keypad"
+
+  clock-names:
+    description: Names of the clocks listed in clocks property in the same order
+    maxItems: 1
+    items:
+    	- const: kpd
+
+  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
+    maxItems: 1
+
+  linux,keymap:
+    description: The keymap for keys as described in the binding document
+    refs: devicetree/bindings/input/matrix-keymap.txt
+    minItems: 1
+
+  reg:
+    description: The base address of the Keypad register bank
+    maxItems: 1
+
+  wakeup-source:
+    description: use any event on keypad as wakeup event
+    type: boolean
+
+  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. If not specified, the default value is 1.
+
+  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.
+    If not specified, the default value is 1.
+
+  mediatek,debounce-us:
+    description: Debounce interval in microseconds, if not specified, the default
+    value is 16000
+    maximum: 256000
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - linux,keymap
+  - clocks
+  - clock-names
+
+examples:
+  - |
+
+  kp@10010000 {
+    compatible = "mediatek,mt6779-keypad";
+    reg = <0 0x10010000 0 0x1000>;
+    linux,keymap = < MATRIX_KEY(0x00, 0x00, KEY_VOLUMEDOWN) >;
+    interrupts = <GIC_SPI 75 IRQ_TYPE_EDGE_FALLING>;
+    clocks = <&clk26m>;
+    clock-names = "kpd";
+  };
Signature · 5 lines
2.18.0
_______________________________________________
Linux-mediatek mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-mediatek
#2 lore raw

Re: [PATCH v17 1/3] dt-bindings: Add bindings for Mediatek matrix keypad

Hi,

Quoted 13 lines · Fengping Yu

From: "fengping.yu" <[email protected]>

This patch add devicetree bindings for Mediatek matrix keypad driver.

---
 .../devicetree/bindings/input/mtk-kpd.yaml    | 87 +++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +0 -0
new file mode 100644
index 000000000000..d74dd8a6fbde

<...>

Documentation/devicetree/bindings/input/mtk-kpd.yaml line 62

Quoted 9 lines
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +9 -0
+  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. If not specified, the default value is 1.
+
+  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.
+    If not specified, the default value is 1.

Your source code can't really handle dts without rows/columns properties. Also, the default value doesn't make any sense. No IC will have rows or columns set to 1.

Since these are IC specified, not board specified, I think you should just have the correct numbers in driver.

Joe.C

maintainer
#3 lore raw

Re: [PATCH v17 1/3] dt-bindings: Add bindings for Mediatek matrix keypad

Hi,

Quoted 31 lines · Yingjoe Chen

Hi,

Quoted 13 lines · Fengping Yu

From: "fengping.yu" <[email protected]>

This patch add devicetree bindings for Mediatek matrix keypad driver.

---
 .../devicetree/bindings/input/mtk-kpd.yaml    | 87 +++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +0 -0
new file mode 100644
index 000000000000..d74dd8a6fbde

<...>

Documentation/devicetree/bindings/input/mtk-kpd.yaml line 62

Quoted 9 lines
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +9 -0
+  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. If not specified, the default value is 1.
+
+  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.
+    If not specified, the default value is 1.
Quoted 6 lines

Your source code can't really handle dts without rows/columns properties. Also, the default value doesn't make any sense. No IC will have rows or columns set to 1.

Since these are IC specified, not board specified, I think you should just have the correct numbers in driver.

It is actually property of board to decide how many keys it wants to wire up. In extreme case it will be a single key, i.e. number of rows and columns will indeed be 1.

Thanks.

Signature · 1 line
Dmitry
#4 lore raw

Re: [PATCH v17 1/3] dt-bindings: Add bindings for Mediatek matrix keypad

Quoted 38 lines · Dmitry Torokhov

Hi,

Quoted 35 lines · Yingjoe Chen

Hi,

Quoted 13 lines · Fengping Yu

From: "fengping.yu" <[email protected]>

This patch add devicetree bindings for Mediatek matrix keypad driver.

---
 .../devicetree/bindings/input/mtk-kpd.yaml    | 87 +++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +0 -0
new file mode 100644
index 000000000000..d74dd8a6fbde

<...>

Documentation/devicetree/bindings/input/mtk-kpd.yaml line 62

Quoted 9 lines
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +9 -0
+  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. If not specified, the default value is 1.
+
+  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.
+    If not specified, the default value is 1.

Your source code can't really handle dts without rows/columns properties. Also, the default value doesn't make any sense. No IC will have rows or columns set to 1.

Quoted 9 lines
Quoted 2 lines

Since these are IC specified, not board specified, I think you should just have the correct numbers in driver.

It is actually property of board to decide how many keys it wants to wire up. In extreme case it will be a single key, i.e. number of rows and columns will indeed be 1.

Thanks.

From the binding "it is not equal to PCB columns number, instead you should add required value for each IC."
Driver code use this to calculate bit position in register, which is IC dependent.

Joe.C

maintainer
#5 lore raw

Re: [PATCH v17 1/3] dt-bindings: Add bindings for Mediatek matrix keypad

In reply to Fengping Yu

Hi,

Quoted 63 lines · Fengping Yu

From: "fengping.yu" <[email protected]>

This patch add devicetree bindings for Mediatek matrix keypad driver.

---
 .../devicetree/bindings/input/mtk-kpd.yaml    | 87 +++++++++++++++++++
 1 file changed, 87 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +47 -0
new file mode 100644
index 000000000000..d74dd8a6fbde
@@ -0,0 +1,87 @@
+# SPDX-License-Identifier: GPL-2.0
+%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 <[email protected]>
+
+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:
+    oneOf:
+      - const: "mediatek,mt6779-keypad"
+      - const: "mediatek,mt6873-keypad"
+
+  clock-names:
+    description: Names of the clocks listed in clocks property in the same order
+    maxItems: 1
+    items:
+    	- const: kpd
+
+  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
+    maxItems: 1
+
+  linux,keymap:
+    description: The keymap for keys as described in the binding document
+    refs: devicetree/bindings/input/matrix-keymap.txt
+    minItems: 1
+
+  reg:
+    description: The base address of the Keypad register bank

Documentation/devicetree/bindings/input/mtk-kpd.yaml line 57

Quoted 10 lines
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +10 -0
+    maxItems: 1
+
+  wakeup-source:
+    description: use any event on keypad as wakeup event
+    type: boolean
+
+  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. If not specified, the default value is 1.

What sets the default? matrix_keymap_parse_properties() will error out if either property is not present....

Quoted 14 lines
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +14 -0
+
+  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.
+    If not specified, the default value is 1.
+
+  mediatek,debounce-us:
+    description: Debounce interval in microseconds, if not specified, the default
+    value is 16000
+    maximum: 256000
+
+required:
+  - compatible
+  - reg

Documentation/devicetree/bindings/input/mtk-kpd.yaml line 81

Quoted 10 lines
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +10 -0
+  - interrupts
+  - linux,keymap
+  - clocks
+  - clock-names
+
+examples:
+  - |
+
+  kp@10010000 {
+    compatible = "mediatek,mt6779-keypad";

Should we call the driver mt6779-keypad ?

Quoted 8 lines
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +6 -0
+    reg = <0 0x10010000 0 0x1000>;
+    linux,keymap = < MATRIX_KEY(0x00, 0x00, KEY_VOLUMEDOWN) >;
+    interrupts = <GIC_SPI 75 IRQ_TYPE_EDGE_FALLING>;
+    clocks = <&clk26m>;
+    clock-names = "kpd";
+  };
Signature · 1 line
2.18.0

Thanks.

Signature · 6 lines
Dmitry

_______________________________________________
Linux-mediatek mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-mediatek