From patchwork Thu Jan 9 00:26:21 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming-Jen X-Patchwork-Id: 13931746 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 4859FE7719A for ; Thu, 9 Jan 2025 00:30:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:To:From:Reply-To: Cc:Content-Type:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=YsIZZl60dEIPjl7pc2az7uHZ2HOwUEGN+MqA0/H9AGA=; b=yL3+71ZbFV7Q+NCfV9t2J+J7zj N9g70HXWbqHYSFUBrRiZMItR8XC+tdP0ukQfCpmRIHvNFaQ9csoxrder32aDZs1MLtg1GhVio1Tuz LtjAWm4aBru9ivSMsbLeh1TMdjA+rSHSFLRgvE6mmTHG7CXrmQuiQeRX/E0a76YnzkICBn093OgWq 2N9BByKpBXxASJ/a+G68neqhGU3+7kJqaxVeMdRJyRRr06QgsYnEzqPpYn5ko8IjcH2iUXYMfMKbc Y75qauFswaTeBsA/j+ARXzeciw+/s3qyseCsrAu936mbb5dGkBLMuvj8YgLAVij7aqokxVgCvbMN8 EP8ixp6g==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98 #2 (Red Hat Linux)) id 1tVgQp-0000000AF5g-143d; Thu, 09 Jan 2025 00:29:51 +0000 Received: from mail-pl1-x633.google.com ([2607:f8b0:4864:20::633]) by bombadil.infradead.org with esmtps (Exim 4.98 #2 (Red Hat Linux)) id 1tVgOH-0000000AEb5-1bwa for linux-arm-kernel@lists.infradead.org; Thu, 09 Jan 2025 00:27:14 +0000 Received: by mail-pl1-x633.google.com with SMTP id d9443c01a7336-216281bc30fso6084265ad.0 for ; Wed, 08 Jan 2025 16:26:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1736382393; x=1736987193; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=YsIZZl60dEIPjl7pc2az7uHZ2HOwUEGN+MqA0/H9AGA=; b=UXubD2ousH2nIHyL0I/iVHtCZdnZ4lR/prqTwwJS0LX1jlgdh7mlciif7pCwZ1qQTk 05W8azmE56rlfiWvlxuj20yNFWZPzkftvczJJIBahSof418NE5at2xvk1YbGkmbN9wky tCdnnU5N/35fDiMwbq+mpdIOTM+B8Fd/iVPTtyw0FxrrDAkrxr8ths7gLKOUgHg9sSKN zzAN86yHxvcntbtpS9dBfrO+4eFmQuVs2XdeejYeyUnaKyoDvPWV1qU24e3sqzCuQgN8 Ez6rMDPXT3tO6u8tjyY0Gp2rIKTgetx2GMABtODvjY1J3zVj6fiSHkkiRvroTllIwZUS 8rDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736382393; x=1736987193; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=YsIZZl60dEIPjl7pc2az7uHZ2HOwUEGN+MqA0/H9AGA=; b=kFBSVNMmlwuIDyWK9vdXirkIGAiUONET/YfpURHyR7p48JZld/XAEr2CLkLlASb9Zd rVoNZ70R7gas2cT0YI2Jymf1V06p3XyFq/QakIB+ODBo0R2C0NUuhtEbrTQuNqoY9J6q 0HXnGgicVrkdfC4/AUyvuWZOtsiuPBOWWi9BqwFaEACrDH02BKlfEXvqaMvO1ydqUpMr V+NLSqVNipFGpYGr1F05qY8BJxLCeIQPAd4Bx03jGAYazNPWGVr55pgyMyUyHVMObBwS /DNk4TeRIIQZ6pbsuPV3JJte7S9UFSIxaSbYJkpiQP/TeOQhhzngQ+yYQ0alcUh8bvdL U16Q== X-Forwarded-Encrypted: i=1; AJvYcCWjlUkT3Dtq60/HY5kgnkW+O+U/Fa/NaswbquLUWmGbrDwvWjyVg2382FI+bfwPGH5QLEYz9FXxFgl/KYTM4AcA@lists.infradead.org X-Gm-Message-State: AOJu0Yz2tAu0Y6M6N9L96pzSAMDvQxPr5vy4MObG8YZo5TLCRHeSxK/u mGYS2CApvnhrxhcLVu7DSNBzozI2CqLb+j6PT9GJwI40VtPu1vPV X-Gm-Gg: ASbGnctP20ukSyVR+rVF9wkS1lI2mqjC0FwErkPYMa3z4J1fKiYLHe1XkwHn5eNxMLQ 5YUJ/lm0tJkIAeomwjNTpcAl568YbKh/LkSE9Sv8ksNcOK9ceY1tuWTrn34Zzadv3EyD3lPtFzO zVnbhhxfin71TemYLRiy1o21Ix85EGWOrICazLreWN6XFqUOKaLcGGpU1Lmt8pZlhUOyV1Tqowe 2O1Pq6cehf6c+hJW+N8dMOpy0DuMjzZu5DUUi4hKZR8ZnsSD+mLG/cjYbFefq32ZERBF+4qn3X/ qjcsdPCOdakE9tPkEAnOAD4ULd9aHkZX63nnvadJQQ== X-Google-Smtp-Source: AGHT+IFTwpCgtAWhcoiuknE8MbwvNCyYt4hh1A1hVKRcuqvUytlhUI6C1CnNX6kuasEuhW0eiQu9rA== X-Received: by 2002:a17:903:2301:b0:211:3275:3fe with SMTP id d9443c01a7336-21a83f5243bmr69201615ad.17.1736382392607; Wed, 08 Jan 2025 16:26:32 -0800 (PST) Received: from localhost.localdomain (60-250-196-139.hinet-ip.hinet.net. [60.250.196.139]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-219dca01989sm333481435ad.239.2025.01.08.16.26.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Jan 2025 16:26:32 -0800 (PST) From: Ming-Jen To: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, linux-input@vger.kernel.org, linux-arm-kernel@lists.infradead.org, mjchen0829@gmail.com, sudeep.holla@arm.com, arnd@arndb.de, peng.fan@nxp.com, conor+dt@kernel.org, krzk+dt@kernel.org, robh@kernel.org, dmitry.torokhov@gmail.com Subject: [PATCH v6 1/2] dt-bindings: input: Add Nuvoton MA35D1 keypad Date: Thu, 9 Jan 2025 00:26:21 +0000 Message-Id: <20250109002622.771-2-mjchen0829@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20250109002622.771-1-mjchen0829@gmail.com> References: <20250109002622.771-1-mjchen0829@gmail.com> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20250108_162713_413852_09A3A03A X-CRM114-Status: GOOD ( 13.78 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org From: Ming-jen Chen Add YAML bindings for MA35D1 SoC keypad. Signed-off-by: Ming-jen Chen Reviewed-by: Krzysztof Kozlowski --- .../bindings/input/nuvoton,ma35d1-keypad.yaml | 82 +++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 Documentation/devicetree/bindings/input/nuvoton,ma35d1-keypad.yaml diff --git a/Documentation/devicetree/bindings/input/nuvoton,ma35d1-keypad.yaml b/Documentation/devicetree/bindings/input/nuvoton,ma35d1-keypad.yaml new file mode 100644 index 000000000000..9d262f87dca0 --- /dev/null +++ b/Documentation/devicetree/bindings/input/nuvoton,ma35d1-keypad.yaml @@ -0,0 +1,82 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/input/nuvoton,ma35d1-keypad.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Nuvoton MA35D1 Keypad + +maintainers: + - Ming-jen Chen + +allOf: + - $ref: /schemas/input/matrix-keymap.yaml# + +properties: + compatible: + const: nuvoton,ma35d1-keypad + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 1 + + linux,keymap: + description: Keymap for the keypad. + + keypad,num-rows: + description: Number of rows in the keypad. + minimum: 2 + maximum: 8 + + keypad,num-columns: + description: Number of columns in the keypad. + minimum: 1 + maximum: 8 + + debounce-delay-ms: + description: Debounce delay time in milliseconds. + maxItems: 1 + + scan-interval-ms: + description: Scan interval time in milliseconds. + maxItems: 1 + +required: + - compatible + - reg + - interrupts + - clocks + - linux,keymap + - keypad,num-rows + - keypad,num-columns + - debounce-delay-ms + - scan-interval-ms + +unevaluatedProperties: false + +examples: + - | + #include + keypad@404a0000 { + compatible = "nuvoton,ma35d1-keypad"; + reg = <0x404a0000 0x10000>; + interrupts = <79>; + clocks = <&clk>; + keypad,num-rows = <2>; + keypad,num-columns = <2>; + + linux,keymap = < + MATRIX_KEY(0, 0, KEY_ENTER) + MATRIX_KEY(0, 1, KEY_ENTER) + MATRIX_KEY(1, 0, KEY_SPACE) + MATRIX_KEY(1, 1, KEY_Z) + >; + + debounce-delay-ms = <1>; + scan-interval-ms = <20>; + }; From patchwork Thu Jan 9 00:26:22 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming-Jen X-Patchwork-Id: 13931747 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 855F7E77188 for ; Thu, 9 Jan 2025 00:31:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:To:From:Reply-To: Cc:Content-Type:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=A8Pnd05CDej6BIvXK9SxMVIRhmFMlG06bflDHXLe24k=; b=avtOOrAlMtPT03qOrR5GkmZiQK w4TD/nDTQ3V8cQvIrBCirm4r1ixwmx3myu2WmPurIsXcUcMaiW93WBI/IW9uZ+UAj0AUm6oIBLrRE lTFlqReEFSl2+BytBKHqP9NbdytVI9Hed2ikg2oawa3AAyufkEhHD152VVh2YEU5lveAYwIKnGZV5 mzqvXeYHDQzbJggmj/h8tLDMq0XdYJL9OFeiXOyb6n53qOWWE6LcaPlxZiujK/IRYKLvgovGdUTbq OtwZaU/awJE81F6/qM3IhMGRM5sPvIj7VZmKFXZ8E8sJSIuVsgrf2rX+cCW5zHHsZp5XW9I93Q5I5 fRI/Yepg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98 #2 (Red Hat Linux)) id 1tVgRz-0000000AFFR-3Z4F; Thu, 09 Jan 2025 00:31:03 +0000 Received: from mail-pl1-x630.google.com ([2607:f8b0:4864:20::630]) by bombadil.infradead.org with esmtps (Exim 4.98 #2 (Red Hat Linux)) id 1tVgOK-0000000AEbT-3DWQ for linux-arm-kernel@lists.infradead.org; Thu, 09 Jan 2025 00:27:19 +0000 Received: by mail-pl1-x630.google.com with SMTP id d9443c01a7336-216401de828so4564975ad.3 for ; Wed, 08 Jan 2025 16:26:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1736382396; x=1736987196; darn=lists.infradead.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=A8Pnd05CDej6BIvXK9SxMVIRhmFMlG06bflDHXLe24k=; b=TCrTECKWOPA8v20Ic1ILjEteUNtVNEZBVMTP98nEYZE4L+e4YOjLTvqECXtDXXtfGK lpsztVxyJKs0lIPNK72PmgDlQcaSmFJQA2Kkwm5EC4Tz9Yc/sOKfflcZk22M1EmpZFCz qx+glKtaXjFLn1J3Id+qhAsyNgkoA/X/FEuthOBxUGlZsiOBYiIP4c5feLMKxXUIth9j IpaikxS3aTucr1c06H1EJoAyv1jxKCGhOPzyFUiv9v5F4gNCkC5sn1P2oKiqqGEo5xaU lUDZ1P3axDidXI1pUMhLh8IHMRdAH45kHtz2m49SkcfYyyYv6nu6+tQlQNuqRzuhlJrQ 0ukA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736382396; x=1736987196; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=A8Pnd05CDej6BIvXK9SxMVIRhmFMlG06bflDHXLe24k=; b=StY1N/RgkNuB+Tn3Ln/j0WC6gXMKw1N9w4pN/X2WwAHOtuF6Azyb1/od/pxH+wRqsL dupkj6fhQ7MXKCrwJcvCW64UUXFv8Lzg/ShBXePZYjly6MXjb8mDQiEUyu+I5jO3NTEM MO5ERqdZh+snLEgyWTCZ5EBcfj7pFeAEX/Z31CvMp0vswuVlPmrjpiUEQg8dmJdpaB1z vPFxgVH1vKjjJluJHx4LvRtdgM+MvJjY9dv3K7mvboqRBcRqL/xva1Ptoev7uFhKC5/H O9RBT2gFFwOIKgcXJRU/UI7qhTFjArkL0No192x4VkOoLN3Vi1kQREhaS3RF/l+3s6Hb M/DA== X-Forwarded-Encrypted: i=1; AJvYcCWYIGYmpJVUY31Zj0YNviNRSnddkzU2kjswzptBYXW0r24UBFpCgtspKc4a3xKcQXTS5Bl/JjDPtwFFT0NiuJb5@lists.infradead.org X-Gm-Message-State: AOJu0YxYJtgSqXNG0lqhI1CUAia5Y0PIRRqKKPvxVkzRC00SK8QUSM8O zNOFmDIXQfObazbDM+zkDbyVWO6Q0IbtbpWSatx2FsIF3b5W/QNH X-Gm-Gg: ASbGncsGGyemDjukrh5WkCM0Tf/NL8gEG3A1uUCWORmTKkWMC7ZqplKB21WN7sHcIVr 67VqjeOKh6UhS7zxqsVJsD2bWy3s+ap18NNeaFCwIXFQm5tk4e5mtB3KTFVMOc2R3nTPN775IUs LJCK7lfUPbXB+aaLJCj/+ENA2NTL/98OwB66/UowevZXn7+0RN18SBtiAWv34V6mLzg6WGJ/pNG ZxxQGD9ruoukL0pPja+sjKR1tTV+ojALLEmn9QQIIVdjfn5KEpTHY8KpduuV+wbsL4zL8p5jwnQ usrhlYf4R0pFqmFDabiofWDom8jqTYCUMpsxnUsK7A== X-Google-Smtp-Source: AGHT+IEaG5FHqd4dxnTIamsZeeFu94HBxNkJdQKitv0P+xzB9G5fKILJ9pAt0YuPtDCATSmNXsaCzg== X-Received: by 2002:a17:903:2b03:b0:216:2f7f:ff69 with SMTP id d9443c01a7336-21a83f36d33mr77279855ad.5.1736382395507; Wed, 08 Jan 2025 16:26:35 -0800 (PST) Received: from localhost.localdomain (60-250-196-139.hinet-ip.hinet.net. [60.250.196.139]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-219dca01989sm333481435ad.239.2025.01.08.16.26.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Jan 2025 16:26:35 -0800 (PST) From: Ming-Jen To: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, linux-input@vger.kernel.org, linux-arm-kernel@lists.infradead.org, mjchen0829@gmail.com, sudeep.holla@arm.com, arnd@arndb.de, peng.fan@nxp.com, conor+dt@kernel.org, krzk+dt@kernel.org, robh@kernel.org, dmitry.torokhov@gmail.com Subject: [PATCH v6 2/2] input: keypad: add new keypad driver for MA35D1 Date: Thu, 9 Jan 2025 00:26:22 +0000 Message-Id: <20250109002622.771-3-mjchen0829@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20250109002622.771-1-mjchen0829@gmail.com> References: <20250109002622.771-1-mjchen0829@gmail.com> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20250108_162716_799267_BC5DFFEA X-CRM114-Status: GOOD ( 29.21 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org From: Ming-jen Chen Adds a new keypad driver for the MA35D1 platform. The driver supports key scanning and interrupt handling. Signed-off-by: Ming-jen Chen --- drivers/input/keyboard/Kconfig | 10 + drivers/input/keyboard/Makefile | 1 + drivers/input/keyboard/ma35d1_keypad.c | 387 +++++++++++++++++++++++++ 3 files changed, 398 insertions(+) create mode 100644 drivers/input/keyboard/ma35d1_keypad.c diff --git a/drivers/input/keyboard/Kconfig b/drivers/input/keyboard/Kconfig index 721ab69e84ac..d7c0d0f4a88d 100644 --- a/drivers/input/keyboard/Kconfig +++ b/drivers/input/keyboard/Kconfig @@ -797,4 +797,14 @@ config KEYBOARD_CYPRESS_SF To compile this driver as a module, choose M here: the module will be called cypress-sf. +config KEYBOARD_MA35D1 + tristate "Nuvoton MA35D1 keypad driver" + depends on ARCH_MA35 || COMPILE_TEST + select INPUT_MATRIXKMAP + help + Say Y here if you want to use Nuvoton MA35D1 keypad. + + To compile this driver as a module, choose M here: the + module will be called ma35d1-keypad. + endif diff --git a/drivers/input/keyboard/Makefile b/drivers/input/keyboard/Makefile index 1e0721c30709..9b858cdd1b6b 100644 --- a/drivers/input/keyboard/Makefile +++ b/drivers/input/keyboard/Makefile @@ -70,3 +70,4 @@ obj-$(CONFIG_KEYBOARD_TEGRA) += tegra-kbc.o obj-$(CONFIG_KEYBOARD_TM2_TOUCHKEY) += tm2-touchkey.o obj-$(CONFIG_KEYBOARD_TWL4030) += twl4030_keypad.o obj-$(CONFIG_KEYBOARD_XTKBD) += xtkbd.o +obj-$(CONFIG_KEYBOARD_MA35D1) += ma35d1_keypad.o diff --git a/drivers/input/keyboard/ma35d1_keypad.c b/drivers/input/keyboard/ma35d1_keypad.c new file mode 100644 index 000000000000..befae383eaa3 --- /dev/null +++ b/drivers/input/keyboard/ma35d1_keypad.c @@ -0,0 +1,387 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * MA35D1 keypad driver + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* Keypad Interface Registers */ +#define KPI_CONF 0x00 +#define KPI_3KCONF 0x04 +#define KPI_STATUS 0x08 +#define KPI_RSTC 0x0C +#define KPI_KEST 0x10 +#define KPI_KPE0 0x18 +#define KPI_KPE1 0x1C +#define KPI_KRE0 0x20 +#define KPI_KRE1 0x24 +#define KPI_PRESCALDIV 0x28 + +/* KPI_CONF - Keypad Configuration Register */ +#define KROW GENMASK(30, 28) /* Keypad Matrix ROW number */ +#define KCOL GENMASK(26, 24) /* Keypad Matrix COL Number */ +#define DB_CLKSEL GENMASK(19, 16) /* De-bounce sampling cycle selection */ +#define PRESCALE GENMASK(15, 8) /* Row Scan Cycle Pre-scale Value */ +#define WAKEUP BIT(5) /* Lower Power Wakeup Enable */ +#define INTEN BIT(3) /* Key Interrupt Enable Control */ +#define RKINTEN BIT(2) /* Release Key Interrupt Enable */ +#define PKINTEN BIT(1) /* Press Key Interrupt Enable Control */ +#define ENKP BIT(0) /* Keypad Scan Enable */ + +/* KPI_STATUS - Keypad Status Register */ +#define PKEY_INT BIT(4) /* Press key interrupt */ +#define RKEY_INT BIT(3) /* Release key interrupt */ +#define KEY_INT BIT(2) /* Key Interrupt */ +#define RST_3KEY BIT(1) /* 3-Keys Reset Flag */ +#define PDWAKE BIT(0) /* Power Down Wakeup Flag */ + +#define KEY_EVENT_BITS 64 + +#define NUM_SETTINGS 12 +#define PRE_SCALE_MAX 256 +#define PRE_SCALE_DIV_MAX 256 + +static const unsigned int debounce_values[NUM_SETTINGS] = { + 0, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192 +}; + +static const unsigned int debounce_register[NUM_SETTINGS] = { + 0x0, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xA, 0xB, 0xC, 0xD +}; + +struct ma35d1_keypad { + struct clk *clk; + struct input_dev *input_dev; + void __iomem *mmio_base; + int irq; + u32 kpi_row; + u32 kpi_col; + u32 debounce_val; + u32 pre_scale; + u32 pre_scale_div; +}; + +static void ma35d1_keypad_scan_matrix(struct ma35d1_keypad *keypad, unsigned int status) +{ + struct input_dev *input_dev = keypad->input_dev; + u32 row_shift = get_count_order(keypad->kpi_col); + u32 *keymap = input_dev->keycode; + u32 code, key, index; + u32 key_event[4]; + u64 pressed_keys = 0, released_keys = 0; + + /* Read key event status */ + key_event[0] = readl(keypad->mmio_base + KPI_KPE0); + key_event[1] = readl(keypad->mmio_base + KPI_KPE1); + key_event[2] = readl(keypad->mmio_base + KPI_KRE0); + key_event[3] = readl(keypad->mmio_base + KPI_KRE1); + + /* Clear key event status */ + writel(key_event[0], (keypad->mmio_base + KPI_KPE0)); + writel(key_event[1], (keypad->mmio_base + KPI_KPE1)); + writel(key_event[2], (keypad->mmio_base + KPI_KRE0)); + writel(key_event[3], (keypad->mmio_base + KPI_KRE1)); + + pressed_keys = key_event[0] | ((u64)key_event[1] << 32); + released_keys = key_event[2] | ((u64)key_event[3] << 32); + + /* Process pressed keys */ + for_each_set_bit(index, (const unsigned long *)&pressed_keys, KEY_EVENT_BITS) { + code = MATRIX_SCAN_CODE(index / 8, (index % 8), row_shift); + key = keymap[code]; + + input_event(input_dev, EV_MSC, MSC_SCAN, code); + input_report_key(input_dev, key, 1); + } + + /* Process released keys */ + for_each_set_bit(index, (const unsigned long *)&released_keys, KEY_EVENT_BITS) { + code = MATRIX_SCAN_CODE(index / 8, (index % 8), row_shift); + key = keymap[code]; + + input_event(input_dev, EV_MSC, MSC_SCAN, code); + input_report_key(input_dev, key, 0); + } + + input_sync(input_dev); +} + +static irqreturn_t ma35d1_keypad_interrupt(int irq, void *dev_id) +{ + struct ma35d1_keypad *keypad = dev_id; + unsigned int kstatus; + + kstatus = readl(keypad->mmio_base + KPI_STATUS); + + if (kstatus & (PKEY_INT | RKEY_INT)) { + ma35d1_keypad_scan_matrix(keypad, kstatus); + } else { + if (kstatus & PDWAKE) + writel(PDWAKE, (keypad->mmio_base + KPI_STATUS)); + } + + return IRQ_HANDLED; +} + +static int ma35d1_keypad_open(struct input_dev *dev) +{ + struct ma35d1_keypad *keypad = input_get_drvdata(dev); + u32 val, config; + + val = RKINTEN | PKINTEN | INTEN | ENKP; + val |= FIELD_PREP(KCOL, (keypad->kpi_col - 1)) | FIELD_PREP(KROW, (keypad->kpi_row - 1)); + + config = FIELD_PREP(PRESCALE, (keypad->pre_scale - 1)) | + FIELD_PREP(DB_CLKSEL, keypad->debounce_val); + + val |= config; + + writel(val, keypad->mmio_base + KPI_CONF); + writel((keypad->pre_scale_div - 1), keypad->mmio_base + KPI_PRESCALDIV); + + return 0; +} + +static void ma35d1_keypad_close(struct input_dev *dev) +{ + struct ma35d1_keypad *keypad = input_get_drvdata(dev); + u32 val; + + val = readl(keypad->mmio_base + KPI_KPE0) & ~ENKP; + writel(val, keypad->mmio_base + KPI_CONF); +} + +static int ma35d1_parse_dt(struct ma35d1_keypad *keypad, u32 debounce_ms, u32 scan_interval) +{ + u32 clk_rate = clk_get_rate(keypad->clk); + u32 min_diff = debounce_values[NUM_SETTINGS - 1]; + u32 i, clk_cycles, diff, p, d; + u32 best_diff = 0xffff; + + /* Calculate debounce cycles */ + clk_cycles = clk_rate * debounce_ms / 1000; + + keypad->debounce_val = debounce_register[NUM_SETTINGS - 1]; + + for (i = 0; i < NUM_SETTINGS; i++) { + diff = abs((s32)(clk_cycles - debounce_values[i])); + if (diff < min_diff) { + min_diff = diff; + keypad->debounce_val = debounce_register[i]; + } + } + + /* Find scan time setting */ + clk_cycles = clk_rate * scan_interval / 1000; + clk_cycles = clk_cycles / keypad->kpi_row; + + if (clk_cycles == 0) { + keypad->pre_scale = 1; + keypad->pre_scale_div = 1; + } else if (clk_cycles >= PRE_SCALE_MAX * PRE_SCALE_DIV_MAX) { + keypad->pre_scale = PRE_SCALE_MAX; + keypad->pre_scale_div = PRE_SCALE_DIV_MAX; + } else { + for (p = 1; p <= PRE_SCALE_MAX; p++) { + d = (clk_cycles + (p / 2)) / p; + + if (d > 0 && d <= PRE_SCALE_DIV_MAX) { + diff = abs((s32)(p * d) - clk_cycles); + + if (diff < best_diff) { + best_diff = diff; + keypad->pre_scale = p; + keypad->pre_scale_div = d; + + if (diff == 0) + break; + } + } + } + } + + /* + * Hardware Limitation: + * Due to the hardware design, the keypad debounce time must not exceed + * half of the row scan time. + * + * The row scan time is determined by the formula: + * Row Scan Time = pre_scale * pre_scale_div + * + * Therefore, the debounce time must satisfy the following condition: + * Debounce Time < (Row Scan Time / 2) + * + * For example: + * If pre_scale = 64, pre_scale_div = 32, + * then Row Scan Time = 64 * 32 = 2048 keypad clock. + * Hence, the maximum allowable debounce time is 1024 keypad clock. + */ + + if (keypad->debounce_val >= (keypad->pre_scale * keypad->pre_scale_div) / 2) + return -EINVAL; + + return 0; +} + +static int ma35d1_keypad_probe(struct platform_device *pdev) +{ + struct ma35d1_keypad *keypad; + struct input_dev *input_dev; + struct resource *res; + u32 debounce, scan_interval; + int error = 0; + + keypad = devm_kzalloc(&pdev->dev, sizeof(*keypad), GFP_KERNEL); + if (!keypad) + return -ENOMEM; + + input_dev = devm_input_allocate_device(&pdev->dev); + if (!input_dev) + return -ENOMEM; + + res = platform_get_resource(pdev, IORESOURCE_MEM, 0); + if (!res) + return -ENODEV; + + keypad->mmio_base = devm_ioremap_resource(&pdev->dev, res); + if (IS_ERR(keypad->mmio_base)) + return dev_err_probe(&pdev->dev, PTR_ERR(keypad->mmio_base), + "failed to remap I/O memor\n"); + + keypad->irq = platform_get_irq(pdev, 0); + if (keypad->irq < 0) { + dev_err(&pdev->dev, "failed to get IRQ\n"); + return keypad->irq; + } + + keypad->clk = devm_clk_get_enabled(&pdev->dev, NULL); + if (IS_ERR(keypad->clk)) + return dev_err_probe(&pdev->dev, PTR_ERR(keypad->clk), "failed to get core clk\n"); + + error = matrix_keypad_parse_properties(&pdev->dev, &keypad->kpi_row, &keypad->kpi_col); + if (error) { + dev_err(&pdev->dev, "failed to parse keypad params\n"); + return error; + } + + error = matrix_keypad_build_keymap(NULL, NULL, keypad->kpi_row, keypad->kpi_col, + NULL, input_dev); + if (error) { + dev_err(&pdev->dev, "failed to build keymap\n"); + return error; + } + + keypad->input_dev = input_dev; + input_dev->name = pdev->name; + input_dev->id.bustype = BUS_HOST; + input_dev->open = ma35d1_keypad_open; + input_dev->close = ma35d1_keypad_close; + input_dev->dev.parent = &pdev->dev; + + error = device_property_read_u32(&pdev->dev, "debounce-delay-ms", &debounce); + if (error) { + dev_err(&pdev->dev, "failed to acquire 'debounce-delay-ms'\n"); + return error; + } + + error = device_property_read_u32(&pdev->dev, "scan-interval-ms", &scan_interval); + if (error) { + dev_err(&pdev->dev, "failed to acquire 'scan-interval'\n"); + return error; + } + + error = ma35d1_parse_dt(keypad, debounce, scan_interval); + if (error) { + dev_err(&pdev->dev, "keypad dt params error\n"); + return error; + } + + __set_bit(EV_REP, input_dev->evbit); + input_set_drvdata(input_dev, keypad); + input_set_capability(input_dev, EV_MSC, MSC_SCAN); + + error = devm_request_irq(&pdev->dev, keypad->irq, ma35d1_keypad_interrupt, + IRQF_NO_SUSPEND, pdev->name, keypad); + if (error) { + dev_err(&pdev->dev, "failed to request IRQ\n"); + return error; + } + + platform_set_drvdata(pdev, keypad); + device_init_wakeup(&pdev->dev, 1); + + error = dev_pm_set_wake_irq(&pdev->dev, keypad->irq); + if (error) { + dev_err(&pdev->dev, "failed to enable irq wake\n"); + return error; + } + + error = input_register_device(input_dev); + if (error) { + dev_err(&pdev->dev, "failed to register input device\n"); + return error; + } + + return 0; +} + +static void ma35d1_keypad_remove(struct platform_device *pdev) +{ + struct ma35d1_keypad *keypad = platform_get_drvdata(pdev); + + input_unregister_device(keypad->input_dev); +} + +static int ma35d1_keypad_suspend(struct device *dev) +{ + struct ma35d1_keypad *keypad = dev_get_drvdata(dev); + + if (device_may_wakeup(dev)) + writel(readl(keypad->mmio_base + KPI_CONF) | WAKEUP, keypad->mmio_base + KPI_CONF); + + return 0; +} + +static int ma35d1_keypad_resume(struct device *dev) +{ + struct ma35d1_keypad *keypad = dev_get_drvdata(dev); + + if (device_may_wakeup(dev)) + writel(readl(keypad->mmio_base + KPI_CONF) & ~(WAKEUP), + keypad->mmio_base + KPI_CONF); + + return 0; +} + +static DEFINE_SIMPLE_DEV_PM_OPS(ma35d1_pm_ops, ma35d1_keypad_suspend, ma35d1_keypad_resume); + +static const struct of_device_id ma35d1_kpi_of_match[] = { + { .compatible = "nuvoton,ma35d1-keypad"}, + {}, +}; +MODULE_DEVICE_TABLE(of, ma35d1_kpi_of_match); + +static struct platform_driver ma35d1_keypad_driver = { + .probe = ma35d1_keypad_probe, + .remove = ma35d1_keypad_remove, + .driver = { + .name = "ma35d1-keypad", + .pm = pm_sleep_ptr(&ma35d1_pm_ops), + .of_match_table = ma35d1_kpi_of_match, + }, +}; +module_platform_driver(ma35d1_keypad_driver); + +MODULE_AUTHOR("Ming-Jen Chen"); +MODULE_DESCRIPTION("MA35D1 Keypad Driver"); +MODULE_LICENSE("GPL");