[v6,1/3] dt-bindings: Change keypad documentation schema

Commit Message

Fengping Yu May 9, 2020, 2:04 a.m. UTC

From: "fengping.yu" <[e-mail]>

Change Mediatek matrix keypad dt-bindings doc to yaml schema.

Signed-off-by: fengping.yu <[e-mail]>
---
 .../devicetree/bindings/input/mtk-kpd.txt     | 61 ------------
 .../devicetree/bindings/input/mtk-kpd.yaml    | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 61 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.txt
 create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml

Patch

diff --git a/Documentation/devicetree/bindings/input/mtk-kpd.txt b/Documentation/devicetree/bindings/input/mtk-kpd.txt
deleted file mode 100644
index 8b154a5e2f7d..000000000000
--- a/Documentation/devicetree/bindings/input/mtk-kpd.txt
+++ /dev/null
@@ -1,61 +0,0 @@ 
-* Mediatek's Keypad Controller device tree binding
-
-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.
-
-Required properties:
-- compatible should contain:
-	* "mediatek,kp" for common keypad
-	* "mediatek,mt6779-keypad" for specific keypad chip
-
-- reg: The base address of the Keypad register bank.
-
-- interrupts: A single interrupt specifier.
-
-- mediatek,debounce-us: Debounce interval in microseconds, maximum value
-  is 256000 microseconds.
-
-- keypad,num-rows: 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.
-
-- keypad,num-columns: 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.
-
-- linux,keymap: The keymap for keys as described in the binding document
-  devicetree/bindings/input/matrix-keymap.txt.
-
-- pinctrl: Should specify pin control groups used for this controller.
-  See ../pinctrl/pinctrl-bindings.txt for details.
-
-- clocks: Must contain one entry, for the module clock.
-  See ../clocks/clock-bindings.txt for details.
-
-- clock-names: Names of the clocks listed in clocks property in the same order.
-
-Optional Properties:
-- wakeup-source: use any event on keypad as wakeup event.
-
-Example:
-
-	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..bd4247322e3c
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/mtk-kpd.yaml
@@ -0,0 +1,93 @@ 
+%YAML 1.2
+---
+version: 1
+
+id: mtk-keypad
+
+title: Mediatek's Keypad Controller device tree bindings
+
+maintainer:
+  - name: Fengping Yu <[e-mail]>
+
+description: >
+  TODO
+
+properties:
+  - name: "compatible"
+      constraint: |
+        "mediatek,mt6779-keypad"
+        "mediatek, kp"
+    clock-names:
+    clocks:
+    interrupts:
+    linux,keymap
+    pinctrl-0:
+    pinctrl-names:
+    reg:
+    wakeup-source:
+    keypad,num-columns:
+    keypad,num-rows:
+    mediatek,debounce-us
+    status:
+...
+# * Mediatek's Keypad Controller device tree binding
+#
+# 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.
+#
+# Required properties:
+# - compatible should contain:
+# 	* "mediatek,kp" for common keypad
+# 	* "mediatek,mt6779-keypad" for specific keypad chip
+#
+# - reg: The base address of the Keypad register bank.
+#
+# - interrupts: A single interrupt specifier.
+#
+# - mediatek,debounce-us: Debounce interval in microseconds, maximum value
+#   is 256000 microseconds.
+#
+# - keypad,num-rows: 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.
+#
+# - keypad,num-columns: 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.
+#
+# - linux,keymap: The keymap for keys as described in the binding document
+#   devicetree/bindings/input/matrix-keymap.txt.
+#
+# - pinctrl: Should specify pin control groups used for this controller.
+#   See ../pinctrl/pinctrl-bindings.txt for details.
+#
+# - clocks: Must contain one entry, for the module clock.
+#   See ../clocks/clock-bindings.txt for details.
+#
+# - clock-names: Names of the clocks listed in clocks property in the same order.
+#
+# Optional Properties:
+# - wakeup-source: use any event on keypad as wakeup event.
+#
+# Example:
+#
+# 	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>;
+# 	};