From nobody Mon Jun 15 10:15:11 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B0E72C433EF for ; Fri, 29 Apr 2022 23:31:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1381865AbiD2XfF (ORCPT ); Fri, 29 Apr 2022 19:35:05 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57816 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1381854AbiD2Xew (ORCPT ); Fri, 29 Apr 2022 19:34:52 -0400 Received: from mail-pj1-x102e.google.com (mail-pj1-x102e.google.com [IPv6:2607:f8b0:4864:20::102e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 02DD9DA6E9 for ; Fri, 29 Apr 2022 16:31:16 -0700 (PDT) Received: by mail-pj1-x102e.google.com with SMTP id p6so8324069pjm.1 for ; Fri, 29 Apr 2022 16:31:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=KUEQR9O8H+8oiHtgEVn7Ig/wUneKMih0Bx8ImUVBxBc=; b=Vh4E1cv9OunyuoisT11pRvmxs46iSzdYkmWT3ac1s2WpS8JBE4ecvsT0MQOF/bdkii aBVyAtrTmi96qZznM6ha3lwdHqEL3h7EI05n5qVBpEPV+8WBBrlkJ4//KnF9Gmov7kiz jaC/4iRkkYra/ed3fUcSxd+ISJ7+TjEC2aDgE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=KUEQR9O8H+8oiHtgEVn7Ig/wUneKMih0Bx8ImUVBxBc=; b=caM7SzYHa/CiEa6QSHE+i6s+BRvLK7tU1xUHw6SwmH1ypaoL7tZyOPXuhF/d8IRe4k 4L+gSZW1B1Oam9BdGnE3hqjMy9mvvJtmGYBT8aC928XStOYscwuWxguBs7YA1KpUwUS6 44guIhErluIivzVms97ZhvQIUTgZjIR5Y5UoBckFnDDsq2TWNVIzh6r2BocLbhQaRC/U wvWyXWJ8IceDQNm0PAWLrv3LDF/VrXt87GgEBWVwiZXaWDrDg/9RxyZb+R3v1mQb7xeJ 2EB5+6y91igK2VtzxsoEiH2+D8VnCRx2rDzKmZn29kvfcwgSOoo7OJXm47gpXLces8Qe GWaA== X-Gm-Message-State: AOAM530uwk3OvijIstZuIVOx2kZDP9qH3MwmKP0tC2dfH3IQL+rQgD2o B8WlWFetdUzare9ZFaHiWYua6w== X-Google-Smtp-Source: ABdhPJwSMP4RP2g8T5tULOQ96nBkdJwyXyDbE1C2P4bZNXY/k6AfOVEQyaKWh/BeX2OKIr+67wz67w== X-Received: by 2002:a17:903:2091:b0:15c:b49b:664d with SMTP id d17-20020a170903209100b0015cb49b664dmr1608696plc.151.1651275075510; Fri, 29 Apr 2022 16:31:15 -0700 (PDT) Received: from smtp.gmail.com ([2620:15c:202:201:5172:14b3:3687:1fb0]) by smtp.gmail.com with ESMTPSA id i24-20020aa78b58000000b0050dc762818esm223037pfd.104.2022.04.29.16.31.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Apr 2022 16:31:15 -0700 (PDT) From: Stephen Boyd To: Dmitry Torokhov Cc: linux-kernel@vger.kernel.org, patches@lists.linux.dev, chrome-platform@lists.linux.dev, Krzysztof Kozlowski , Rob Herring , devicetree@vger.kernel.org, Benson Leung , Guenter Roeck , Douglas Anderson , Hsin-Yi Wang , "Joseph S. Barrera III" Subject: [PATCH v2 1/2] dt-bindings: google,cros-ec-keyb: Introduce switches only compatible Date: Fri, 29 Apr 2022 16:31:11 -0700 Message-Id: <20220429233112.2851665-2-swboyd@chromium.org> X-Mailer: git-send-email 2.36.0.464.gb9c8b46e94-goog In-Reply-To: <20220429233112.2851665-1-swboyd@chromium.org> References: <20220429233112.2851665-1-swboyd@chromium.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" If the device is a detachable, this device won't have a matrix keyboard but it may have some button switches, e.g. volume buttons and power buttons. Let's add a more specific compatible for this type of device that indicates to the OS that there are only switches and no matrix keyboard present. If only the switches compatible is present, then the matrix keyboard properties are denied. This lets us gracefully migrate devices that only have switches over to the new compatible string. Similarly, start enforcing that the keypad rows/cols and keymap properties exist if the google,cros-ec-keyb compatible is present. This more clearly describes what the driver is expecting, i.e. that the kernel driver will fail to probe if the row or column or keymap properties are missing and only the google,cros-ec-keyb compatible is present. Cc: Krzysztof Kozlowski Cc: Rob Herring Cc: Cc: Benson Leung Cc: Guenter Roeck Cc: Douglas Anderson Cc: Hsin-Yi Wang Cc: "Joseph S. Barrera III" Signed-off-by: Stephen Boyd --- .../bindings/input/google,cros-ec-keyb.yaml | 95 +++++++++++++++++-- 1 file changed, 89 insertions(+), 6 deletions(-) diff --git a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.ya= ml b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml index e8f137abb03c..c1b079449cf3 100644 --- a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml +++ b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml @@ -15,14 +15,19 @@ description: | Google's ChromeOS EC Keyboard is a simple matrix keyboard implemented on a separate EC (Embedded Controller) device. It provides a message for reading key scans from the EC. These are then converted - into keycodes for processing by the kernel. - -allOf: - - $ref: "/schemas/input/matrix-keymap.yaml#" + into keycodes for processing by the kernel. This device also supports + switches/buttons like power and volume buttons. =20 properties: compatible: - const: google,cros-ec-keyb + oneOf: + - items: + - const: google,cros-ec-keyb-switches + - items: + - const: google,cros-ec-keyb-switches + - const: google,cros-ec-keyb + - items: + - const: google,cros-ec-keyb =20 google,needs-ghost-filter: description: @@ -41,15 +46,40 @@ properties: where the lower 16 bits are reserved. This property is specified only when the keyboard has a custom design for the top row keys. =20 +dependencies: + function-row-phsymap: [ 'linux,keymap' ] + google,needs-ghost-filter: [ 'linux,keymap' ] + required: - compatible =20 +allOf: + - if: + properties: + compatible: + contains: + const: google,cros-ec-keyb + then: + allOf: + - $ref: "/schemas/input/matrix-keymap.yaml#" + - if: + not: + properties: + compatible: + contains: + const: google,cros-ec-keyb-switches + then: + required: + - keypad,num-rows + - keypad,num-columns + - linux,keymap + unevaluatedProperties: false =20 examples: - | #include - cros-ec-keyb { + keyboard-controller { compatible =3D "google,cros-ec-keyb"; keypad,num-rows =3D <8>; keypad,num-columns =3D <13>; @@ -113,3 +143,56 @@ examples: /* UP LEFT */ 0x070b0067 0x070c0069>; }; + + - | + keyboard-controller { + compatible =3D "google,cros-ec-keyb-switches", "google,cros-ec-key= b"; + /* Matrix keymap properties are allowed but ignored */ + keypad,num-rows =3D <8>; + keypad,num-columns =3D <13>; + linux,keymap =3D < + /* CAPSLCK F1 B F10 */ + 0x0001003a 0x0002003b 0x00030030 0x00040044 + /* N =3D R_ALT ESC */ + 0x00060031 0x0008000d 0x000a0064 0x01010001 + /* F4 G F7 H */ + 0x0102003e 0x01030022 0x01040041 0x01060023 + /* ' F9 BKSPACE L_CTRL */ + 0x01080028 0x01090043 0x010b000e 0x0200001d + /* TAB F3 T F6 */ + 0x0201000f 0x0202003d 0x02030014 0x02040040 + /* ] Y 102ND [ */ + 0x0205001b 0x02060015 0x02070056 0x0208001a + /* F8 GRAVE F2 5 */ + 0x02090042 0x03010029 0x0302003c 0x03030006 + /* F5 6 - \ */ + 0x0304003f 0x03060007 0x0308000c 0x030b002b + /* R_CTRL A D F */ + 0x04000061 0x0401001e 0x04020020 0x04030021 + /* S K J ; */ + 0x0404001f 0x04050025 0x04060024 0x04080027 + /* L ENTER Z C */ + 0x04090026 0x040b001c 0x0501002c 0x0502002e + /* V X , M */ + 0x0503002f 0x0504002d 0x05050033 0x05060032 + /* L_SHIFT / . SPACE */ + 0x0507002a 0x05080035 0x05090034 0x050B0039 + /* 1 3 4 2 */ + 0x06010002 0x06020004 0x06030005 0x06040003 + /* 8 7 0 9 */ + 0x06050009 0x06060008 0x0608000b 0x0609000a + /* L_ALT DOWN RIGHT Q */ + 0x060a0038 0x060b006c 0x060c006a 0x07010010 + /* E R W I */ + 0x07020012 0x07030013 0x07040011 0x07050017 + /* U R_SHIFT P O */ + 0x07060016 0x07070036 0x07080019 0x07090018 + /* UP LEFT */ + 0x070b0067 0x070c0069>; + }; + - | + /* No matrix keyboard, just buttons/switches */ + switches { + compatible =3D "google,cros-ec-keyb-switches"; + }; +... --=20 https://chromeos.dev From nobody Mon Jun 15 10:15:11 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CBEDEC433EF for ; Fri, 29 Apr 2022 23:31:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1381892AbiD2XfI (ORCPT ); Fri, 29 Apr 2022 19:35:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57560 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1381857AbiD2Xew (ORCPT ); Fri, 29 Apr 2022 19:34:52 -0400 Received: from mail-pf1-x429.google.com (mail-pf1-x429.google.com [IPv6:2607:f8b0:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3AE96DB498 for ; Fri, 29 Apr 2022 16:31:17 -0700 (PDT) Received: by mail-pf1-x429.google.com with SMTP id a11so8117053pff.1 for ; Fri, 29 Apr 2022 16:31:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=kWF9sCGDLZUK2sgoEIyeIZNot5TI6mJu4iu2/5YFEbs=; b=I4ZrQ02qj5Y2kq+RsM7F/x4rltUPs85PI2jsCeDO07YWMOe6ICw4kN17iLW+muuqND 2bWJtIApxcoKrH7Rg0IB1waVaa3UXApFafxIED0m+uPDHTF/qJAhg5tYHoAsW/JXVomS IxQh1fKEWGgxxaxu1B9nw7vg8ahhN4fv107mQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=kWF9sCGDLZUK2sgoEIyeIZNot5TI6mJu4iu2/5YFEbs=; b=U03E6CTIDk5R02hOR+rlXLaAW3jPgVcqBZ7mSrsPcDIkfb5F9AgHT1xU9NhjVQGiFP hmi8SnBOabnVBiBlokBpXM8Zf6u81BCwhrElttF3zoOkhNW+wfOnwzESb0U7lBWEJ7t7 OHVfkvHAmAos3n4GvmArATpfq3f3S7o0enH7wLyk2sykhsChr3nBha51N35uc3MphMs4 AJFk+WDer4cnlW+9SSOjrzH2NmzH6i9PZYaib1qwKGSmJFoIxNGzSe6AxWrJdPygmzdU p1EPfwDSw4cQLKSrTM4x2Ypf85RxR1Aw03dfFaBiTnUDtB/4lpzzOL4TyJ77k3Y6pjsZ 9uUw== X-Gm-Message-State: AOAM532q3RjHhU38mCf3PlfbmWC1hGeQ2qB1CbKV6GeZk/0X7amNct9E GQlVH94MZqWBFrjNZ6TC+Vlb0g== X-Google-Smtp-Source: ABdhPJxVK4eELgvKjci8XyIkVF5wrZqTYg/voZE1BMP5wikFWF4v/Rp0TQ1AOSdMffDPdkjReT+NiA== X-Received: by 2002:a05:6a00:24ce:b0:50d:c14b:b655 with SMTP id d14-20020a056a0024ce00b0050dc14bb655mr1240258pfv.57.1651275076720; Fri, 29 Apr 2022 16:31:16 -0700 (PDT) Received: from smtp.gmail.com ([2620:15c:202:201:5172:14b3:3687:1fb0]) by smtp.gmail.com with ESMTPSA id i24-20020aa78b58000000b0050dc762818esm223037pfd.104.2022.04.29.16.31.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 29 Apr 2022 16:31:16 -0700 (PDT) From: Stephen Boyd To: Dmitry Torokhov Cc: linux-kernel@vger.kernel.org, patches@lists.linux.dev, chrome-platform@lists.linux.dev, Krzysztof Kozlowski , Rob Herring , devicetree@vger.kernel.org, Benson Leung , Guenter Roeck , Douglas Anderson , Hsin-Yi Wang , "Joseph S. Barrera III" Subject: [PATCH v2 2/2] Input: cros-ec-keyb - skip keyboard registration for switches compatible Date: Fri, 29 Apr 2022 16:31:12 -0700 Message-Id: <20220429233112.2851665-3-swboyd@chromium.org> X-Mailer: git-send-email 2.36.0.464.gb9c8b46e94-goog In-Reply-To: <20220429233112.2851665-1-swboyd@chromium.org> References: <20220429233112.2851665-1-swboyd@chromium.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" In commit 4352e23a7ff2 ("Input: cros-ec-keyb - only register keyboard if rows/columns exist") we skipped registration of the keyboard if the row/columns property didn't exist, but that has a slight problem for existing DTBs. The DTBs have the rows/columns properties, so removing the properties to indicate only switches exist makes this keyboard driver fail to probe, resulting in broken power and volume buttons. Ease the migration of existing DTBs by skipping keyboard registration if the google,cros-ec-keyb-switches compatible exists. The end result is that new DTBs can either choose to remove the matrix keymap properties or leave them in place and add this new compatible indicating the matrix keyboard properties should be ignored. Existing DTBs will continue to work, but they will keep registering the keyboard that does nothing. To fix that problem we can add this extra compatible to existing DTBs and the keyboard will stop being registered. Finally, if google,cros-ec-keyb is missing then this driver won't even attempt to register the matrix keyboard. Cc: Krzysztof Kozlowski Cc: Rob Herring Cc: Cc: Benson Leung Cc: Guenter Roeck Cc: Douglas Anderson Cc: Hsin-Yi Wang Cc: "Joseph S. Barrera III" Fixes: 4352e23a7ff2 ("Input: cros-ec-keyb - only register keyboard if rows/= columns exist") Signed-off-by: Stephen Boyd --- drivers/input/keyboard/cros_ec_keyb.c | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/drivers/input/keyboard/cros_ec_keyb.c b/drivers/input/keyboard= /cros_ec_keyb.c index eef909e52e23..1bbe2987bf52 100644 --- a/drivers/input/keyboard/cros_ec_keyb.c +++ b/drivers/input/keyboard/cros_ec_keyb.c @@ -536,6 +536,12 @@ static int cros_ec_keyb_register_matrix(struct cros_ec= _keyb *ckdev) u32 *physmap; u32 key_pos; unsigned int row, col, scancode, n_physmap; + bool register_keyboard; + + /* Skip matrix registration if no keyboard */ + register_keyboard =3D device_get_match_data(dev); + if (!register_keyboard) + return 0; =20 /* * No rows and columns? There isn't a matrix but maybe there are @@ -718,8 +724,13 @@ static int cros_ec_keyb_remove(struct platform_device = *pdev) =20 #ifdef CONFIG_OF static const struct of_device_id cros_ec_keyb_of_match[] =3D { - { .compatible =3D "google,cros-ec-keyb" }, - {}, + { + /* Must be first */ + .compatible =3D "google,cros-ec-keyb", + .data =3D (void *)true + }, + { .compatible =3D "google,cros-ec-keyb-switches" }, + {} }; MODULE_DEVICE_TABLE(of, cros_ec_keyb_of_match); #endif --=20 https://chromeos.dev