From patchwork Wed Jan 8 01:18:11 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming-Jen X-Patchwork-Id: 13929879 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 6D2EAE77197 for ; Wed, 8 Jan 2025 01:21:01 +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=sYbGITGbEZjb6OpwtH5VOJ2a6xe00YC1HHwGj8LN0wU=; b=NBIzdoYfbwNQQqXUVnC18ScFAD SRKeES79f+ClsxyXXYTmRK9F5GmZhGiUlwNukkAIBbwu8d4Qy2D9M5/wFxh4Faw3sm4bZRR8AjBfq 8L9cNqvH7tMoY91QszanyJuzfnaNfCGL/6ZMu4EEdfVPrZDnzJ33zpJE1L3UNwqKGcCvTn6HKgNcm 7rAKfdJw3nQeFmSr7S+yBHiDiMeoxTVYMxmaAlWHrQqTonVS6+1bqi5ICw/GTuLGnCQNEGjK67tMh PPriw1B+tW/frfu/9j1GYdJJ+D5V/D4/RDYQ5u9SiZyGAmR3fjwgJfLnLzOxEpukccnC9ryXHRK1D AS8J+Ljw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98 #2 (Red Hat Linux)) id 1tVKkc-00000006i0G-3kEt; Wed, 08 Jan 2025 01:20:50 +0000 Received: from mail-pl1-x631.google.com ([2607:f8b0:4864:20::631]) by bombadil.infradead.org with esmtps (Exim 4.98 #2 (Red Hat Linux)) id 1tVKiF-00000006hGb-2Moh for linux-arm-kernel@lists.infradead.org; Wed, 08 Jan 2025 01:18:24 +0000 Received: by mail-pl1-x631.google.com with SMTP id d9443c01a7336-2164b1f05caso234888985ad.3 for ; Tue, 07 Jan 2025 17:18:23 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1736299103; x=1736903903; 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=sYbGITGbEZjb6OpwtH5VOJ2a6xe00YC1HHwGj8LN0wU=; b=h4sIWAUCvjGhuW3DJ53Nun0iEn6lwW0m/X3dsvc1VrbIvZq6TwEaqGKorD1qy6tAbP TULVlHszNOzX4XlBrfbfQVGp0c19RaORD0n/z7dhdG/mHX+iFUj8PvCm+ez1Sbkm5bKp f/EskP94y+cwvxLsCGp+dYidbFXpAUezJ1B+9EZr4wugC1XgEc32TmdUJXJ8k0ScAvzI wFfxv6+OqOArNjaCslt+V7DV/4bsjJouPJqqMc+5Hh8Fn6KjMRPUkiBp7Qp2Pz8Sb7C7 T4OoVIM8lC/ImqgGYFTs72JY9zLLPXFGXhBO+DR8P5wNC3PUWLN3MDRti9tb1N1fNPMz LVsQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736299103; x=1736903903; 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=sYbGITGbEZjb6OpwtH5VOJ2a6xe00YC1HHwGj8LN0wU=; b=vhijefpf+LUVxOnz/rPTi3WreM28ApODMPNYVQ9UJuwt4ohmmz1A3UK7J9gSir9HBd mWRC94pfuvwhwo71HA4FJnzWaClsFqpq0v8EWe7s/hF9PXFKzQMBT2e5avwwqsNkiwGp MhXcqv3G1ZLBHhixssyI9BGZlaLohP930jXgDMylZ344ogzNJ2cdCsGEWj8HxMcSDnRt efH4Ms1sHWSGMP1oeUTYZiT1Cswt7iplIFieMbfNGLmEgU4ZEBpt13zxO8uVHlXf9c7i uuO9dOz/eey1p2A9ELgdc2MS178rOMFwNjkmaeets05t5ivj9ZKEOuCdfzFSrH1ABOUB 25/w== X-Forwarded-Encrypted: i=1; AJvYcCWslfEhGepaRjFqeunEKbWnH4/hOZhhUjTIxvHWnk6JunChNH5x+rE/C4XbZybxwfbRp3bJIUhhWR13Ep6lifwu@lists.infradead.org X-Gm-Message-State: AOJu0YwvZ3YygKf422zFiTQhYxgHOcOlIj8N8s5+gOIWdtnXm/Ojjtzv T0QU1Xi3vNbWm6wnIaHE2KtATsM9umIpf07Tj9TzgpyikIQC9WBh X-Gm-Gg: ASbGnctlGvBJfJZzzVdnM6cdZRFZnw/zegtyPHtk+i6ZRN6zhw3WuvHZE7G58e0LYS9 0kDvUHZGsSpfyf8mO18WJXkhif37bpoODhHBTlBeLoDuVR/j/01g8sFDmQP6UT41OVYjBwe9O0a JJod+aNDsEIj2uYJ/ceHhcYFcWNxWI6Ftff1Ti0ojgumPAcgFXJlGMEnmpFLHCdMNiC6UYjDgIK Pstp/dmBdRhxwSXR71uGCFFUJNsglzOK0D+F4Wx7XsARpATA+wntoZsph7G2zZ+m1P6QhXKnsev QSeuxTvLVlxq30LI8BbMkY5K/XTgwB6QUUrrAAY/JA== X-Google-Smtp-Source: AGHT+IFDcZKcr8r+6R5GTj8bFAPrGBQ0pnx9mZqhIoabk5UESwlqeD+2cfBofS0ds7DMtcNebRzGJA== X-Received: by 2002:a05:6a20:9c9a:b0:1e1:f40d:9783 with SMTP id adf61e73a8af0-1e88d0ee90amr2280910637.40.1736299102840; Tue, 07 Jan 2025 17:18:22 -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 d2e1a72fcca58-72aad83033esm34045009b3a.48.2025.01.07.17.18.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Jan 2025 17:18:22 -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, peng.fan@nxp.com, arnd@arndb.de, sudeep.holla@arm.com, conor+dt@kernel.org, krzk+dt@kernel.org, robh@kernel.org, dmitry.torokhov@gmail.com Subject: [PATCH v5 1/2] dt-bindings: input: Add Nuvoton MA35D1 keypad Date: Wed, 8 Jan 2025 01:18:11 +0000 Message-Id: <20250108011812.627-2-mjchen0829@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20250108011812.627-1-mjchen0829@gmail.com> References: <20250108011812.627-1-mjchen0829@gmail.com> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20250107_171823_606932_7E1D4236 X-CRM114-Status: GOOD ( 14.03 ) 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 --- .../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..889f253b3bc2 --- /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-kpi + + 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-kpi"; + 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 Wed Jan 8 01:18:12 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming-Jen X-Patchwork-Id: 13929880 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 27984E77197 for ; Wed, 8 Jan 2025 01:22:18 +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=1OwGQ/eEmH1Mu8xHiEqS2IPi6r1O9yd9XC8dCgu7ad0=; b=iyBJ6nWvNBcgBqrrfFbA6Xxv4S GGPZj3fesrNMKzH+ZUn0Q9GVNrU9MEhB6zoYO5UkopWARaQn3SMXq9RkDpz7P4aRCizWwP01T1IfN EdoeMS7DqKL2lSwclWazsomB81IvWxGEMMFOdMJJMglqpEwKnthSMhU8qXIsLLAQ2YX0YvxfatC6i gzpUY2fbR7+9lhRmmXnNh5RZKjrxAgZVWci0085l+OkQv6BGh5GZ3jcrweDTg/83yo7tS43fErDHN 6sc5tTDHwYNKQSTd+gJovm7FfDtx3yzPMZ0sfWDVyEL8OTc9XXMXISArquGKRYOd8ZPUcHOSEoQlc 1PyW7euw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98 #2 (Red Hat Linux)) id 1tVKlo-00000006iKz-2C8v; Wed, 08 Jan 2025 01:22:04 +0000 Received: from mail-pl1-x62a.google.com ([2607:f8b0:4864:20::62a]) by bombadil.infradead.org with esmtps (Exim 4.98 #2 (Red Hat Linux)) id 1tVKiI-00000006hGz-2gjA for linux-arm-kernel@lists.infradead.org; Wed, 08 Jan 2025 01:18:27 +0000 Received: by mail-pl1-x62a.google.com with SMTP id d9443c01a7336-2162c0f6a39so6610405ad.0 for ; Tue, 07 Jan 2025 17:18:26 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1736299106; x=1736903906; 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=1OwGQ/eEmH1Mu8xHiEqS2IPi6r1O9yd9XC8dCgu7ad0=; b=NViRa9vQGPiK/GJMsBEkASZmIf3b4t+HNLPQd6RdGbubaIkG8+cqGElC2GQTO9+0+V sP9TdLEMJ7UdUQUfqx4sxDldvsvMuhuqLaJyY0Y2MIPPpZuQaDsb3X9mdHFAW7YUB6G7 0eCN+Vj7N/2O870twkpX/I4HYRQ6HT2N6dSfInDo4Vwe6MGOQD6XBBWOUiwNla3nZGSv iVrDhtbVmLp1b+m5al+sbKBKC0qN2A1Rvq2oMSd5oArEjuh+HH7Sft4lvb03eoaMoW3p 9p17l4HRHxVFuxIZF0g4aVZjfh6yxp40jqrbPo7nZyiMvGLh2QfUeC5GIzNtDvtuUyLa m2NA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736299106; x=1736903906; 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=1OwGQ/eEmH1Mu8xHiEqS2IPi6r1O9yd9XC8dCgu7ad0=; b=my5UPv7EEqlBQgUfMvQTy706YfhDUbDGi9JUoDasg8zBdVCBesW4dWhET1FczrXEVR aMhnQHrEmTawRtZ3iTKThsqE43gO/QQfFZZyCGo1lt3PFzWCiBM/aPb0oubZnOHEHwB6 Vx5LttCqyk9dNuoNx1wgwwkkp9eUcZoITUeGP9OxP45F1isQ4VvUCBlKdKUUHsfVNhTi ZqFTkt1qQdDRjTbqx2ylq97mc3xCOV8/g1KiYd60hPYqhQTpwagq9Kkbwha/AfXUaQNz q4SkeU31bRLgOeMNeN7SjrNlGCM8iZCh3jqvMJ8ohFbGqapd6rO4e5jCMSK56JULD+Mi o58g== X-Forwarded-Encrypted: i=1; AJvYcCVHNaltNRFaVFUf2IPxg22xFJ4FCkcrv8VYs5IiXV932Mgzwa4xyIeDwmX7A16sOoMAKfjSORrzC2kWsIgVR6rF@lists.infradead.org X-Gm-Message-State: AOJu0YxHBSJpo0XSo6vmaI5wVOtxpKFTnav4zlH5ZqYugmB8TTDj7mvm ajr1tcnBMbq49g2upB2sp1H66GLu+pB4u2R0kh+EZ1eKYnYgv/WD X-Gm-Gg: ASbGnct5u7wTrgFVQ+B3bwR24nJGsajDQRp5kOlTa5+/Yv2O6CgtsH/lR3hksTbkf1k I3l1Y2hBM3oOVzG5gkXE8MjCay6CAjdra+ORcIHCyZZw0RrO/5E7aChDE87HuiAwBJ6PM8OtlEA V465CNSPqmctQ5H+XnVX9p4nP1TEY6eTc5kEQIAk3lPi7GHuSlbDnqxIk8NKDU0kQYFPFx76mp7 lR/Y2SC/G/bPEU9FmdEqXMMaZRAhMVdMo2+vec01086dP1XnINVr3LLiRKCIa7fINH9Y3QXtVh3 h23gvBu/AohGoozQsXqsZeNyudltqGePrTfbXoOixg== X-Google-Smtp-Source: AGHT+IH33ViZlygXXZrO1wY0MbeC+KmIfXpVRFwbG+LUTnBRTeOdPfyScTTkYVejKxiDQN3NI7hTkA== X-Received: by 2002:a05:6a20:2587:b0:1e1:adcd:eadb with SMTP id adf61e73a8af0-1e88d133f3amr1713889637.11.1736299105646; Tue, 07 Jan 2025 17:18:25 -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 d2e1a72fcca58-72aad83033esm34045009b3a.48.2025.01.07.17.18.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Jan 2025 17:18:25 -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, peng.fan@nxp.com, arnd@arndb.de, sudeep.holla@arm.com, conor+dt@kernel.org, krzk+dt@kernel.org, robh@kernel.org, dmitry.torokhov@gmail.com Subject: [PATCH v5 2/2] input: keypad: add new keypad driver for MA35D1 Date: Wed, 8 Jan 2025 01:18:12 +0000 Message-Id: <20250108011812.627-3-mjchen0829@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20250108011812.627-1-mjchen0829@gmail.com> References: <20250108011812.627-1-mjchen0829@gmail.com> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20250107_171826_684720_C9CFF99E X-CRM114-Status: GOOD ( 29.62 ) 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..e4e0058d317c --- /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-kpi"}, + {}, +}; +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-kpi", + .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");