Add matrix keypad driver support for Mediatek SoCs
Subsystems (3)
PATCH v8 1/1 Add matrix keypad driver support for Mediatek SoCs
Change since v7:
- specify compatible property as const string
- add maxItem in required property
- squash keypad example nodes
- sort header file with alphabetic order
- align all define values and add MTK_ prefix to make more uniform
- change debounce value to default 16ms if not specified in dts
- remove extra braces
- separate clk prepare as an internal driver function
- add special compatible string
- modify CONFIG_KEYBOARD_MTK_KPD=m to build keypad as ko module
fengping.yu (3):
dt-bindings: Add keypad devicetree documentation
drivers: input: keyboard: Add mtk keypad driver
configs: defconfig: Add CONFIG_ng.yu (3):
dt-bindings: Add keypad devicetree documentation
drivers: input: keyboard: Add mtk keypad driver
configs: defconfig: Add CONFIG_KEYBOARD_MTK_KPD=m
.../devicetree/bindings/input/mtk-kpd.yaml | 94 +++++++ arch/arm64/configs/defconfig | 1 + drivers/input/keyboard/Kconfig | 9 + drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/mtk-kpd.c | 231 ++++++++++++++++++ 5 files changed, 336 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml create mode 100644 drivers/input/keyboard/mtk-kpd.c
--
2.18.0
PATCH v8 1/3 dt-bindings: Add keypad devicetree documentation
From: "fengping.yu" <[email protected]>
Add Mediatek matrix keypad dt-bindings doc as yaml schema.
--- .../devicetree/bindings/input/mtk-kpd.yaml | 94 +++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml
Documentation/devicetree/bindings/input/mtk-kpd.yaml new file +94 -0
@@ -0,0 +1,94 @@ +%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, kp" + + clock-names: + description: Names of the clocks listed in clocks property in the same order + maxItems: 1 + + 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 + maxItems: 16 + + 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 + maxItems: 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 + + 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 + - linux,keymap + - pinctrl + - clocks + - clock-names + +examples: + - | + + keypad: kp@10010000 { + compatible = "mediatek,kp"; + 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"; + pinctrl-names = "default"; + pinctrl-0 = <&kpd_gpios_def_cfg>; + };
Signature · 5 lines
2.18.0 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH v8 2/3 drivers: input: keyboard: Add mtk keypad driver
In reply to Fengping YuFrom: "fengping.yu" <[email protected]>
This adds matrix keypad support for Mediatek SoCs.
--- drivers/input/keyboard/Kconfig | 9 ++ drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/mtk-kpd.c | 231 +++++++++++++++++++++++++++++++ 3 files changed, 241 insertions(+) create mode 100644 drivers/input/keyboard/mtk-kpd.c
drivers/input/keyboard/Kconfig +9 -0
@@ -782,6 +782,15 @@ config KEYBOARD_BCM To compile this driver as a module, choose M here: the module will be called bcm-keypad. +config KEYBOARD_MTK_KPD + tristate "MediaTek Keypad Support" + depends on OF && HAVE_CLK + help + Say Y here if you want to use the keypad on MediaTek SoCs. + If unsure, say N. + To compile this driver as a module, choose M here: the + module will be called mtk-kpd. + config KEYBOARD_MTK_PMIC tristate "MediaTek PMIC keys support" depends on MFD_MT6397
drivers/input/keyboard/Makefile +1 -0
@@ -43,6 +43,7 @@ obj-$(CONFIG_KEYBOARD_MATRIX) += matrix_keypad.o obj-$(CONFIG_KEYBOARD_MAX7359) += max7359_keypad.o obj-$(CONFIG_KEYBOARD_MCS) += mcs_touchkey.o obj-$(CONFIG_KEYBOARD_MPR121) += mpr121_touchkey.o +obj-$(CONFIG_KEYBOARD_MTK_KPD) += mtk-kpd.o obj-$(CONFIG_KEYBOARD_MTK_PMIC) += mtk-pmic-keys.o obj-$(CONFIG_KEYBOARD_NEWTON) += newtonkbd.o obj-$(CONFIG_KEYBOARD_NOMADIK) += nomadik-ske-keypad.o
drivers/input/keyboard/mtk-kpd.c new file +231 -0
231 lines not on this page · raw message
Signature · 5 lines
2.18.0 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Re: [PATCH v8 2/3] drivers: input: keyboard: Add mtk keypad driver
Hi,
Quoted 17 lines · Fengping Yu
From: "fengping.yu" <[email protected]>
This adds matrix keypad support for Mediatek SoCs.
Signed-off-by fengping.yu <[email protected]>--- drivers/input/keyboard/Kconfig | 9 ++ drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/mtk-kpd.c | 231 +++++++++++++++++++++++++++++++ 3 files changed, 241 insertions(+) create mode 100644 drivers/input/keyboard/mtk-kpd.cdrivers/input/keyboard/Kconfig +0
-0
drivers/input/keyboard/Kconfig config KEYBOARD_BCM · line 787
Quoted 6 lines
drivers/input/keyboard/Kconfig +3
-0@@ -782,6 +782,15 @@ config KEYBOARD_BCM To compile this driver as a module, choose M here: the module will be called bcm-keypad. +config KEYBOARD_MTK_KPD + tristate "MediaTek Keypad Support" + depends on OF && HAVE_CLK
Please drop those deps and instead use:
depends on ARCH_MEDIATEK && ARM64
There are still some missing deps:
select CONFIG_REGMAP_MMIO
select INPUT_MATRIXKMAP
and check which clock driver must be enabled:
COMMON_CLK_MT6779_MMSYSCOMMON_CLK_MT6779_IMGSYSCOMMON_CLK_MT6779_IPESYSCOMMON_CLK_MT6779_CAMSYSCOMMON_CLK_MT6779_VDECSYSCOMMON_CLK_MT6779_VENCSYSCOMMON_CLK_MT6779_MFGCFGCOMMON_CLK_MT6779_AUDSYS
Quoted 37 lines
drivers/input/keyboard/Kconfig +6
-0+ help + Say Y here if you want to use the keypad on MediaTek SoCs. + If unsure, say N. + To compile this driver as a module, choose M here: the + module will be called mtk-kpd. + config KEYBOARD_MTK_PMIC tristate "MediaTek PMIC keys support" depends on MFD_MT6397drivers/input/keyboard/Makefile +1
-0@@ -43,6 +43,7 @@ obj-$(CONFIG_KEYBOARD_MATRIX) += matrix_keypad.o obj-$(CONFIG_KEYBOARD_MAX7359) += max7359_keypad.o obj-$(CONFIG_KEYBOARD_MCS) += mcs_touchkey.o obj-$(CONFIG_KEYBOARD_MPR121) += mpr121_touchkey.o +obj-$(CONFIG_KEYBOARD_MTK_KPD) += mtk-kpd.o obj-$(CONFIG_KEYBOARD_MTK_PMIC) += mtk-pmic-keys.o obj-$(CONFIG_KEYBOARD_NEWTON) += newtonkbd.o obj-$(CONFIG_KEYBOARD_NOMADIK) += nomadik-ske-keypad.odrivers/input/keyboard/mtk-kpd.c new file +10
-0@@ -0,0 +1,231 @@ +// SPDX-License-Identifier: GPL-2.0 +/* +* Copyright (C) 2019 MediaTek Inc. +* Author Terry Chang <[email protected]> +*/ +#include <linux/bitops.h> +#include <linux/clk.h> +#include <linux/input/matrix_keypad.h> +#include <linux/interrupt.h> +#include <linux/module.h>
drivers/input/keyboard/mtk-kpd.c line 20
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+#include <linux/property.h> +#include <linux/pinctrl/consumer.h> +#include <linux/platform_device.h> +#include <linux/regmap.h> + +#define MTK_KPD_NAME "mtk-kpd" +#define MTK_KPD_MEM 0x0004 +#define MTK_KPD_DEBOUNCE 0x0018 +#define MTK_KPD_DEBOUNCE_MASK GENMASK(13, 0) +#define MTK_KPD_DEBOUNCE_MAX_US 256000/*256ms */
Thanks for aligning the defines but the 256ms comment is still useless as Andy already said.
Quoted 62 lines
drivers/input/keyboard/mtk-kpd.c new file +62
-0+#define MTK_KPD_NUM_MEMS 5 +#define MTK_KPD_NUM_BITS 136/* 4*32+8 MEM5 only use 8 BITS */ + +struct mtk_keypad { +struct regmap *regmap; +struct input_dev *input_dev; +struct clk *clk; +void __iomem *base; +bool wakeup; +u32 n_rows; +u32 n_cols; + DECLARE_BITMAP(keymap_state, MTK_KPD_NUM_BITS); +}; + +static const struct regmap_config keypad_regmap_cfg = { + .reg_bits =32 , + .val_bits =32 , + .reg_stride =sizeof (u32), + .max_register =36 , +}; + +static irqreturn_t kpd_irq_handler (int irq,void *dev_id) +{ +struct mtk_keypad *keypad = dev_id; +unsigned short *keycode = keypad->input_dev->keycode; +DECLARE_BITMAP (new_state,MTK_KPD_NUM_BITS ); +DECLARE_BITMAP (change,MTK_KPD_NUM_BITS ); +int bit_nr; +int pressed; +unsigned short code; + +regmap_raw_read (keypad->regmap,MTK_KPD_MEM , new_state,MTK_KPD_NUM_MEMS ); + +bitmap_xor (change, new_state, keypad->keymap_state,MTK_KPD_NUM_BITS ); + +for_each_set_bit (bit_nr, change,MTK_KPD_NUM_BITS ) { +/* 1: not pressed, 0: pressed */ + pressed = !test_bit (bit_nr, new_state); +dev_dbg (&keypad->input_dev->dev,"%s" , + pressed ?"pressed" :"released" ); + +/* 32bit register only use low 16bit as keypad mem register */ + code = keycode[bit_nr -16 * (BITS_TO_U32 (bit_nr) -1 )]; + +input_report_key (keypad->input_dev, code, pressed); +input_sync (keypad->input_dev); + +dev_dbg (&keypad->input_dev->dev, +"report Linux keycode = %d\n" , code); + } + +bitmap_copy (keypad->keymap_state, new_state,MTK_KPD_NUM_BITS ); + +return IRQ_HANDLED ; +} + +static int kpd_probe_clock (struct platform_device *pdev,struct clk *clk) +{ +int ret; + + clk =devm_clk_get (&pdev->dev,"kpd" ); +if (IS_ERR (clk))
drivers/input/keyboard/mtk-kpd.c line 92
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+return clk; + + ret =clk_prepare_enable (clk); +if (ret) { +dev_err (&pdev->dev,"cannot prepare/enable keypad clock\n" ); +return ret; + } + + ret = devm_add_action_or_reset(&pdev->dev, + (void (*)(void *))clk_disable_unprepare,
^
Please avoid this and instead use a driver internal function.
drivers/input/keyboard/mtk-kpd.c line 96
Quoted 4 lines
drivers/input/keyboard/mtk-kpd.c new file +4
-0+ clk); + +return ret; +}
That was not my intention. You can do all the stuff within the probe() routine.
Quoted 37 lines
drivers/input/keyboard/mtk-kpd.c new file +37
-0+ +static int kpd_pdrv_probe (struct platform_device *pdev) +{ +struct mtk_keypad *keypad; +struct pinctrl *keypad_pinctrl; +struct pinctrl_state *kpd_default; +unsigned int irqnr; +u32 debounce; +int ret; + + keypad =devm_kzalloc (&pdev->dev,sizeof (*keypad),GFP_KERNEL ); +if (!keypad) +return -ENOMEM ; + + keypad->base =devm_platform_ioremap_resource (pdev,0 ); +if (IS_ERR (keypad->base)) +return PTR_ERR (keypad->base); + + keypad->regmap =devm_regmap_init_mmio (&pdev->dev, + keypad->base, + &keypad_regmap_cfg); +if (IS_ERR (keypad->regmap)) { +dev_err (&pdev->dev, +"regmap init failed:%ld\n" ,PTR_ERR (keypad->regmap)); +return PTR_ERR (keypad->regmap); + } + +bitmap_fill (keypad->keymap_state,MTK_KPD_NUM_BITS ); + + keypad->input_dev =devm_input_allocate_device (&pdev->dev); +if (!keypad->input_dev) { +dev_err (&pdev->dev,"Failed to allocate input dev\n" ); +return -ENOMEM ; + } + + keypad->input_dev->name =MTK_KPD_NAME ; + keypad->input_dev->id.bustype =BUS_HOST ;
drivers/input/keyboard/mtk-kpd.c line 143
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+ + ret =matrix_keypad_parse_properties (&pdev->dev, &keypad->n_rows, + &keypad->n_cols); +if (ret) { +dev_err (&pdev->dev,"Failed to parse keypad params\n" ); +return ret; + } + +if (device_property_read_u32 (&pdev->dev,"mediatek,debounce-us" , + &debounce))
Did you executed checkpatch.pl here? There are a few more style issues within the patch.
Quoted 13 lines
drivers/input/keyboard/mtk-kpd.c new file +13
-0+ debounce =16000 ; + +if (debounce >MTK_KPD_DEBOUNCE_MAX_US ) { +dev_err (&pdev->dev,"Debounce time exceeds the maximum allowed time 256ms\n" ); +return -EINVAL ; + } + + keypad->wakeup =device_property_read_bool (&pdev->dev,"wakeup-source" ); + +dev_dbg (&pdev->dev,"n_row=%d n_col=%d debounce=%d\n" , + keypad->n_rows, keypad->n_cols, debounce); + + ret = matrix_keypad_build_keymap(NULL, NULL,
drivers/input/keyboard/mtk-kpd.c line 166
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+ keypad->n_rows, + keypad->n_cols, +NULL , + keypad->input_dev); +if (ret) { +dev_err (&pdev->dev,"Failed to build keymap\n" ); +return ret; + } + +input_set_drvdata (keypad->input_dev, keypad);
This is useless.
Quoted 14 lines
drivers/input/keyboard/mtk-kpd.c new file +14
-0+ +regmap_write (keypad->regmap,KP_DEBOUNCE , + debounce *32 /1000 &MTK_KPD_DEBOUNCE_MASK ); + +if (kpd_probe_clock (pdev, keypad->clk)) { +dev_err (&pdev->dev,"Failed to enable clock\n" ); +return ret; + } + + keypad_pinctrl =devm_pinctrl_get (&pdev->dev); +if (IS_ERR (keypad_pinctrl)) +return PTR_ERR (keypad_pinctrl); + + kpd_default =pinctrl_lookup_state (keypad_pinctrl,"default" );
drivers/input/keyboard/mtk-kpd.c line 190
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+if (IS_ERR (kpd_default)) { +dev_err (&pdev->dev,"No default pinctrl state\n" ); +return PTR_ERR (kpd_default); + } + +pinctrl_select_state (keypad_pinctrl, kpd_default); + + irqnr =platform_get_irq (pdev,0 ); +if (irqnr <0 ) { +dev_err (&pdev->dev,"Failed to get irq\n" );
Andy already said that platform_get_irq() prints a error so you can just 'return -irqnr'.
drivers/input/keyboard/mtk-kpd.c line 196
Quoted 6 lines
drivers/input/keyboard/mtk-kpd.c new file +6
-0+return -irqnr; + } + + ret =devm_request_threaded_irq (&pdev->dev, irqnr, +NULL , kpd_irq_handler,0 , +MTK_KPD_NAME , keypad);
Still missaligned, pls use checkpatch.pl
Quoted 5 lines
drivers/input/keyboard/mtk-kpd.c new file +5
-0+if (ret) { +dev_err (&pdev->dev,"Failed to request IRQ#%d:%d\n" , + irqnr, ret); +return ret; + }
drivers/input/keyboard/mtk-kpd.c line 211
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+ + ret =input_register_device (keypad->input_dev); +if (ret) { +dev_err (&pdev->dev,"Failed to register device\n" ); +return ret; + } + +device_init_wakeup (&pdev->dev, keypad->wakeup); + +return 0 ;
Here we can 'return device_init_wakeup(&pdev->dev, keypad->wakeup);'
drivers/input/keyboard/mtk-kpd.c line 216
Quoted 5 lines
drivers/input/keyboard/mtk-kpd.c new file +5
-0+} + +static const struct of_device_id kpd_of_match[] = { + {.compatible ="mediatek, mt6779-keypad" }, + {.compatible ="mediatek,kp" },
^
Missing whitespacedrivers/input/keyboard/mtk-kpd.c line 217
Quoted 1 line
drivers/input/keyboard/mtk-kpd.c new file +1
-0+ {/*sentinel*/ }
^ ^ Missing whitespaces
Regards,
Marco
Quoted 16 lines
drivers/input/keyboard/mtk-kpd.c new file +14
-0+}; + +static struct platform_driver kpd_pdrv = { + .probe = kpd_pdrv_probe, + .driver = { + .name =MTK_KPD_NAME , + .of_match_table = kpd_of_match, + }, +}; +module_platform_driver (kpd_pdrv); + +MODULE_AUTHOR ("Mediatek Corporation" ); +MODULE_DESCRIPTION ("MTK Keypad (KPD) Driver" ); +MODULE_LICENSE ("GPL" );Signature · 1 line
2.18.0
_______________________________________________
linux-arm-kernel mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Re: [PATCH v8 2/3] drivers: input: keyboard: Add mtk keypad driver
Quoted 1 line · Marco Felsch
On 20-05-15 14:20, Fengping Yu wrote:
...
Quoted 3 lines
drivers/input/keyboard/Kconfig config KEYBOARD_BCM · line 787
Quoted 1 line
drivers/input/keyboard/Kconfig +1
-0+ depends on OF && HAVE_CLKPlease drop those deps and instead use:
+1
Quoted 1 line
depends on
ARCH_MEDIATEK&& ARM64
I would go even further
depends on (ARCH_MEDIATEK && ARM64) || COMPILE_TEST
Quoted 4 lines
There are still some missing deps:
select
CONFIG_REGMAP_MMIO
selectINPUT_MATRIXKMAP
...
Quoted 4 lines
Quoted 1 line
+#define
MTK_KPD_DEBOUNCE_MAX_US256000 /*256ms */Thanks for aligning the defines but the 256ms comment is still useless as Andy already said.
Yes, it seems my comments partially (?) have been ignored.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v8 2/3] drivers: input: keyboard: Add mtk keypad driver
Quoted 9 lines · Andy Shevchenko
Quoted 1 line · Marco Felsch
On 20-05-15 14:20, Fengping Yu wrote:
...
Quoted 3 lines
drivers/input/keyboard/Kconfig config KEYBOARD_BCM · line 787
Quoted 1 line
drivers/input/keyboard/Kconfig +1
-0+ depends on OF && HAVE_CLKPlease drop those deps and instead use:
Quoted 6 lines
+1
Quoted 1 line
depends on
ARCH_MEDIATEK&& ARM64I would go even further
depends on (ARCH_MEDIATEK && ARM64) || COMPILE_TEST
Please drop ARM64. This works for 32bits SoC as well.
Joe.C
PATCH v8 3/3 configs: defconfig: Add CONFIG_KEYBOARD_MTK_KPD=m
In reply to Fengping YuFrom: "fengping.yu" <[email protected]>
Add Mediatek matrix keypad support in defconfig.
--- arch/arm64/configs/defconfig | 1 + 1 file changed, 1 insertion(+)
arch/arm64/configs/defconfig +1 -0
@@ -349,6 +349,7 @@ CONFIG_KEYBOARD_GPIO=y CONFIG_KEYBOARD_SNVS_PWRKEY=m CONFIG_KEYBOARD_IMX_SC_KEY=m CONFIG_KEYBOARD_CROS_EC=y +CONFIG_KEYBOARD_MTK_KPD=m CONFIG_INPUT_TOUCHSCREEN=y CONFIG_TOUCHSCREEN_ATMEL_MXT=m CONFIG_INPUT_MISC=y
Signature · 5 lines
2.18.0 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Quoted 12 lines · Fengping Yu
Change since v7:
- specify compatible property as const string
- add maxItem in required property
- squash keypad example nodes
- sort header file with alphabetic order
- align all define values and addMTK_prefix to make more uniform
- change debounce value to default 16ms if not specified in dts
- remove extra braces
- separate clk prepare as an internal driver function
- add special compatible string
- modifyCONFIG_KEYBOARD_MTK_KPD=mto build keypad as ko module
You forgot to address at least some of my comments...
Quoted 21 lines
fengping.yu (3):
dt-bindings: Add keypad devicetree documentation
drivers: input: keyboard: Add mtk keypad driver
configs: defconfig: Add CONFIG_ng.yu (3):
dt-bindings: Add keypad devicetree documentation
drivers: input: keyboard: Add mtk keypad driver
configs: defconfig: AddCONFIG_KEYBOARD_MTK_KPD=m.../devicetree/bindings/input/mtk-kpd.yaml | 94 +++++++ arch/arm64/configs/defconfig | 1 + drivers/input/keyboard/Kconfig | 9 + drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/mtk-kpd.c | 231 ++++++++++++++++++ 5 files changed, 336 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml create mode 100644 drivers/input/keyboard/mtk-kpd.c--
2.18.0
Signature · 2 lines
With Best Regards, Andy Shevchenko