Add matrix keypad driver support for Mediatek SoCs
Subsystems (4)
PATCH v9 1/1 Add matrix keypad driver support for Mediatek SoCs
Change since v8:
- update keypad config dependent items
- remove useless comment about debounce time
- use internal function as devm_add_action_or_reset callback
- remove input_set_drvdata
- remove redundant log
- add missing whitespace with compatible sentinel string
fengping.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 | 11 + drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/mtk-kpd.c | 219 ++++++++++++++++++ 5 files changed, 326 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/mtk-kpd.yaml create mode 100644 drivers/input/keyboard/mtk-kpd.c
Signature · 1 line
2.18.0
PATCH v9 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 v9 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 | 11 ++ drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/mtk-kpd.c | 219 +++++++++++++++++++++++++++++++ 3 files changed, 231 insertions(+) create mode 100644 drivers/input/keyboard/mtk-kpd.c
drivers/input/keyboard/Kconfig +11 -0
@@ -782,6 +782,17 @@ 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 (ARCH_MEDIATEK && ARM) || COMPILE_TEST + select CONFIG_REGMAP_MMIO + select INPUT_MATRIXKMAP + 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 +219 -0
219 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 v9 2/3] drivers: input: keyboard: Add mtk keypad driver
Hi,
we are in a very good state now :)
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 | 11 ++ drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/mtk-kpd.c | 219 +++++++++++++++++++++++++++++++ 3 files changed, 231 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,17 @@ 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 (ARCH_MEDIATEK && ARM) || COMPILE_TEST
So the driver is only for 32bit Mediatek SoC's?
Quoted 48 lines
drivers/input/keyboard/Kconfig +8
-0+ select CONFIG_REGMAP_MMIO + select INPUT_MATRIXKMAP + 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 +19
-0@@ -0,0 +1,219 @@ +// 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> +#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)
drivers/input/keyboard/mtk-kpd.c line 29
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+#define MTK_KPD_DEBOUNCE_MAX_US 256000 +#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;
Nitpick:
The wakeup member is only used during probe() so this can probably removed from the driver struct. This should only be addressed if you need to send a v10.
Quoted 139 lines
drivers/input/keyboard/mtk-kpd.c new file +139
-0+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 void kpd_clk_disable (void *data) +{ +clk_disable_unprepare (data); +} + +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 ; + + 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)) + debounce =16000 ; + +if (debounce >MTK_KPD_DEBOUNCE_MAX_US ) { +dev_err (&pdev->dev,"Debounce time exceeds the maximum allowed time %dus\n" , +MTK_KPD_DEBOUNCE_MAX_US ); +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 , + keypad->n_rows, + keypad->n_cols, +NULL , + keypad->input_dev); +if (ret) { +dev_err (&pdev->dev,"Failed to build keymap\n" ); +return ret; + } + +regmap_write (keypad->regmap,KP_DEBOUNCE , + debounce *32 /1000 &MTK_KPD_DEBOUNCE_MASK ); + + keypad->clk =devm_clk_get (&pdev->dev,"kpd" ); +if (IS_ERR (clk)) +return clk; + + ret =clk_prepare_enable (keypad->clk); +if (ret) { +dev_err (&pdev->dev,"cannot prepare/enable keypad clock\n" ); +return ret; + } + + ret =devm_add_action_or_reset (&pdev->dev, kpd_clk_disable, + keypad->clk); +if (ret) +return ret;
drivers/input/keyboard/mtk-kpd.c line 178
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+ + 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" ); +if (IS_ERR (kpd_default)) +return PTR_ERR (kpd_default); + +pinctrl_select_state (keypad_pinctrl, kpd_default);
You only request the "default" state here. This is handled by the driver core (pinctrl_bind_pins()) and can be dropped here and we can also remove the "linux/pinctrl/consumer.h" include. Sorry for this late finding.
drivers/input/keyboard/mtk-kpd.c line 182
Quoted 4 lines
drivers/input/keyboard/mtk-kpd.c new file +4
-0+ + irqnr =platform_get_irq (pdev,0 ); +if (irqnr <0 ) +return -irqnr;
^ irqnr is already negative
drivers/input/keyboard/mtk-kpd.c line 189
Quoted 6 lines
drivers/input/keyboard/mtk-kpd.c new file +6
-0+ ret =devm_request_threaded_irq (&pdev->dev, irqnr, +NULL , kpd_irq_handler,0 , +MTK_KPD_NAME , keypad); +if (ret) { +dev_err (&pdev->dev,"Failed to request IRQ#%d:%d\n" , + irqnr, ret);
Still not alligned.
Quoted 6 lines
drivers/input/keyboard/mtk-kpd.c new file +6
-0+return ret; + } + + ret =input_register_device (keypad->input_dev); +if (ret) { +dev_err (&pdev->dev,"Failed to register device\n" );
drivers/input/keyboard/mtk-kpd.c line 205
Quoted 10 lines
drivers/input/keyboard/mtk-kpd.c new file +10
-0+return ret; + } + +return device_init_wakeup (&pdev->dev, keypad->wakeup); +} + +static const struct of_device_id kpd_of_match[] = { + {.compatible ="mediatek, mt6779-keypad" }, + {.compatible ="mediatek,kp" }, + {/* sentinel */ }
There are still missing whitespaces and checkpatch should complain about all three entries, again please use it!
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
Re: [PATCH v9 2/3] drivers: input: keyboard: Add mtk keypad driver
Quoted 17 lines · Marco Felsch
drivers/input/keyboard/mtk-kpd.c line 182
Quoted 3 lines · Fengping Yu
drivers/input/keyboard/mtk-kpd.c new file +3
-0+ irqnr =platform_get_irq (pdev,0 ); +if (irqnr <0 ) +return -irqnr;^ irqnr is already negativedrivers/input/keyboard/mtk-kpd.c line 189
Quoted 6 lines
drivers/input/keyboard/mtk-kpd.c new file +6
-0+ ret =devm_request_threaded_irq (&pdev->dev, irqnr, +NULL , kpd_irq_handler,0 , +MTK_KPD_NAME , keypad); +if (ret) { +dev_err (&pdev->dev,"Failed to request IRQ#%d:%d\n" , + irqnr, ret);Still not alligned.
Quoted 2 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ return ret; + }
And on top, can't we use irq instead of irqnr?
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v9 2/3] drivers: input: keyboard: Add mtk keypad driver
In reply to Fengping YuHi,
just found another typo.
Quoted 1 line · Fengping Yu
From: "fengping.yu" <[email protected]>
...
drivers/input/keyboard/mtk-kpd.c line 203
Quoted 2 lines
drivers/input/keyboard/mtk-kpd.c new file +2
-0+static const struct of_device_id kpd_of_match[] = { + {.compatible ="mediatek, mt6779-keypad" },
^ This is wrong
drivers/input/keyboard/mtk-kpd.c line 204
Quoted 1 line
drivers/input/keyboard/mtk-kpd.c new file +1
-0+ {.compatible = "mediatek,kp"},
I would also drop the generic "mediatek,kp" compatible. Instead we should list all supported SoCs here.
Regards,
Marco
Quoted 17 lines
drivers/input/keyboard/mtk-kpd.c new file +15
-0+ {/* sentinel */ } +}; + +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
PATCH v9 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
Re: [PATCH v9 3/3] configs: defconfig: Add CONFIG_KEYBOARD_MTK_KPD=m
Quoted 5 lines · Fengping Yu
From: "fengping.yu" <[email protected]>
Add Mediatek matrix keypad support in defconfig.
Signed-off-by fengping.yu <[email protected]>
Quoted 18 lines
--- 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=ySignature · 1 line
2.18.0