From nobody Thu May 7 23:18:03 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 C1CF4C433F5 for ; Mon, 16 May 2022 18:35:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1344952AbiEPSfI (ORCPT ); Mon, 16 May 2022 14:35:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38984 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1344909AbiEPSe4 (ORCPT ); Mon, 16 May 2022 14:34:56 -0400 Received: from mail-pl1-x635.google.com (mail-pl1-x635.google.com [IPv6:2607:f8b0:4864:20::635]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B82363D4B4 for ; Mon, 16 May 2022 11:34:55 -0700 (PDT) Received: by mail-pl1-x635.google.com with SMTP id i8so1329848plr.13 for ; Mon, 16 May 2022 11:34:55 -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=qbcqJhLKUQMd1zX04qmN/h9JWdXhbynT494ZfNvmvHI=; b=JHvd/4EDPlvORXuvcnRpxz6E8Dl2ao3R74+2vUHVT0fFbmyaXiotuFAJZGrp0gBMQu t5Ll7s6BV8CemJhL7bdyBnaK9cnr0Mc8HpZpfiLuAJ/hMdBGR18vlsRrFEj8ryJKreos cC7fC0jrlpoxvSb0jaiP92UbHzS087j0Fdn2w= 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=qbcqJhLKUQMd1zX04qmN/h9JWdXhbynT494ZfNvmvHI=; b=tt1+K8Agci9r3PTDKmNg9YRrHEI73ihYtYN/8l/u9Im/IWORHe6ShO/Z6b3NHHElzM gibAenw03imIdgDTIwSNoF9ceC7nUVUIItpGsqXlOCHMsGMBumlLe1yZC8TTDvZyHPad DUtmiGqb/dXj+bwgGfmaeyREOmCdNRUtCOaX5sKgfbXkvW0kJNkV98tpT+yDbADUNPYT UV/JhBIHAOc3P2J1LU/oPUHlD9b8AB29N4NJ6OZEtz8OYjRy/LR1IrCCn/Jisdx4xciW CI7ZDRZpuSfMMWGhAMCMiGBOGOT35B7MuFeZ7UPzeycxo+ZJOR3DTCoFAWAZDaGGXRHQ FU9g== X-Gm-Message-State: AOAM531tF180Y3DXKquY9G+/oIeMjbDl1SyN6n6qMTFplgSVeM9mA88a J6sbc1Xw5uRqf0p9q9mBxw9SQQ== X-Google-Smtp-Source: ABdhPJz0h+6zKGZV/rzsCGCMdySv9MJKFdvWDnQDZvyT8Gv4027IxHavHCWz43+IXk9kloPYIEckaw== X-Received: by 2002:a17:902:e353:b0:161:5096:3038 with SMTP id p19-20020a170902e35300b0016150963038mr12192424plc.24.1652726095223; Mon, 16 May 2022 11:34:55 -0700 (PDT) Received: from smtp.gmail.com ([2620:15c:202:201:7d0d:b8ac:a3e3:757a]) by smtp.gmail.com with ESMTPSA id w16-20020a1709026f1000b0015e8d4eb24fsm7331090plk.153.2022.05.16.11.34.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 16 May 2022 11:34:54 -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 v5 1/2] dt-bindings: google,cros-ec-keyb: Introduce switches only compatible Date: Mon, 16 May 2022 11:34:51 -0700 Message-Id: <20220516183452.942008-2-swboyd@chromium.org> X-Mailer: git-send-email 2.36.0.550.gb090851708-goog In-Reply-To: <20220516183452.942008-1-swboyd@chromium.org> References: <20220516183452.942008-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 ChromeOS board is a detachable, this cros-ec-keyb device won't have a matrix keyboard but it may have some button switches, e.g. volume buttons and power buttons. The driver still registers a keyboard though and that leads to userspace confusion around where the keyboard is. We tried to work around this in commit 4352e23a7ff2 ("Input: cros-ec-keyb - only register keyboard if rows/columns exist") but that led to another problem where removing the rows/columns properties breaks the binding[1]. Technically before that commit the rows/columns properties were required, otherwise the driver would fail to probe. Removing the properties from devicetrees makes the driver fail to probe unless the corresponding driver patch is present. Furthermore, this makes requiring matrix keyboard properties for devices that really have a keyboard impossible because the compatible drives the schema and now the properties are optional. 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. Otherwise, as long as the "google,cros-ec-keyb" copmatible is present, the matrix keyboard properties are required. This more clearly describes what the driver was expecting, i.e. that the kernel driver would fail to probe if the linux,{rows,cols,keymap} properties are missing and the "google,cros-ec-keyb" compatible is present. If the new "google,cros-ec-keyb-switches" compatible is present then the matrix keyboard properties are likely to be ignored by any modern driver, but they're still allowed per the binding if "google,cros-ec-keyb" is present to conform to the original binding and to keep the driver probing when used with newer DTBs. This lets us gracefully migrate devices that only have switches over to the new compatible string and properly enforce the "google,cros-ec-keyb" binding at the same time. Eventually we'll be able to use only "google,cros-ec-keyb-switches" or "google,cros-ec-keyb" when the driver support has baked for a release or two, but we'll always support the combined compatible list so that DTBs can be mixed and matched with kernels, no dependency between the two binaries is required. Link: https://lore.kernel.org/r/CAD=3DFV=3DWey2P_=3D3Lp6M8GEaoyCn1XcYFhfJwf= x43a5f_8H0obwg@mail.gmail.com [1] Reviewed-by: Krzysztof Kozlowski Cc: Rob Herring Cc: Cc: Benson Leung Cc: Guenter Roeck Reviewed-by: Douglas Anderson Cc: Hsin-Yi Wang Cc: "Joseph S. Barrera III" Signed-off-by: Stephen Boyd Reported-by: Douglas Anderson --- .../bindings/input/google,cros-ec-keyb.yaml | 91 +++++++++++++++++-- 1 file changed, 85 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..e1fb68ca00fc 100644 --- a/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml +++ b/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml @@ -15,14 +15,23 @@ 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 + anyOf: + - description: ChromeOS EC with only buttons/switches + - items: + - const: google,cros-ec-keyb-switches + - description: | + (Deprecated) ChromeOS EC with only buttons/switches; optional ma= trix properties + - items: + - const: google,cros-ec-keyb-switches + - const: google,cros-ec-keyb + - description: ChromeOS EC with keyboard and possibly buttons/switch= es + - items: + - const: google,cros-ec-keyb =20 google,needs-ghost-filter: description: @@ -41,15 +50,32 @@ 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 +if: + properties: + compatible: + contains: + const: google,cros-ec-keyb +then: + allOf: + - $ref: "/schemas/input/matrix-keymap.yaml#" + 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 +139,56 @@ examples: /* UP LEFT */ 0x070b0067 0x070c0069>; }; + + - | + keyboard-controller { + compatible =3D "google,cros-ec-keyb-switches", "google,cros-ec-key= b"; + /* Matrix keymap properties are optional 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 */ + keyboard-controller { + compatible =3D "google,cros-ec-keyb-switches"; + }; +... --=20 https://chromeos.dev From nobody Thu May 7 23:18:03 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 C8926C433EF for ; Mon, 16 May 2022 18:35:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1344959AbiEPSfN (ORCPT ); Mon, 16 May 2022 14:35:13 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38998 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1344922AbiEPSe6 (ORCPT ); Mon, 16 May 2022 14:34:58 -0400 Received: from mail-pj1-x1035.google.com (mail-pj1-x1035.google.com [IPv6:2607:f8b0:4864:20::1035]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D542532EFB for ; Mon, 16 May 2022 11:34:56 -0700 (PDT) Received: by mail-pj1-x1035.google.com with SMTP id ev18so4630163pjb.4 for ; Mon, 16 May 2022 11:34:56 -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=B+y3ghcGTNoWHMuz4m4RXJ7SgZxKsd4M4FdcYQjzA2w=; b=cxqvyxqR0vj/bC96KVA7ctZ0rsu4BnDz2HIF7A+msr0g3QETbAY8RBEt6+NmkbvCLy I3EdnrcacKqv1OChq/MXrd5hWhvvjQCvo8XPjWe6ssVQ6QA4elagVf9pTiAxQxHG7dUD 8nZgN9OGTySge3vXLW2ce4lQQWGTL54dsFoz8= 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=B+y3ghcGTNoWHMuz4m4RXJ7SgZxKsd4M4FdcYQjzA2w=; b=uqKuSu2aAMgDwLm8OksHeTOJSrcpAr3D8mpkkg9fdK7unA7UVfrLrHrC8L4d7HVjXL /tFjSmZXNGqx3Bf1t4cfuqDMsY9pfGYSM/i0H6cR/gK0bJLq3EmaCoAoRV9gpTZ33xdu y7kReIit/V1yG8Iklqx/JxuN4Ae7Gys9jbgeSuuocLsGvponnXmyJo9Bmaasktc3Mg5q iOLC1knPhGD8Ey1f5jnLC/HjyvISNyjiNbp+iz3K6TFH7fNK7jJiQOBHk5eKdMvOVvVP KREjS7KED1dJiUT3qfBwueraJWY/hXSE4Vhq0OXl6gph09igMa45GQHSa/UKrXXxsLx5 8Yig== X-Gm-Message-State: AOAM5320a9ju6Bhc2WlW2oW/6wVki5Zt/FPCUplTnxULdw4C6YdAQhoR PTUcHkuUqj8DGsk+QSLSsCIsfg== X-Google-Smtp-Source: ABdhPJx0C4tIVn/hfIjxZ5wNuIjfUUrnAcrjq0nD/REk4Z4lhVGVQF0SHx8yweOLPBONMShvr56Kig== X-Received: by 2002:a17:90b:4f41:b0:1de:bd14:7721 with SMTP id pj1-20020a17090b4f4100b001debd147721mr21000140pjb.9.1652726096358; Mon, 16 May 2022 11:34:56 -0700 (PDT) Received: from smtp.gmail.com ([2620:15c:202:201:7d0d:b8ac:a3e3:757a]) by smtp.gmail.com with ESMTPSA id w16-20020a1709026f1000b0015e8d4eb24fsm7331090plk.153.2022.05.16.11.34.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 16 May 2022 11:34:55 -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 v5 2/2] Input: cros-ec-keyb - skip keyboard registration w/o cros-ec-keyb compatible Date: Mon, 16 May 2022 11:34:52 -0700 Message-Id: <20220516183452.942008-3-swboyd@chromium.org> X-Mailer: git-send-email 2.36.0.550.gb090851708-goog In-Reply-To: <20220516183452.942008-1-swboyd@chromium.org> References: <20220516183452.942008-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 devicetrees 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. Of course, this driver won't probe until this patch is applied in that scenario, but that's OK. This last case is likely only going to be used by new devicetrees created after this commit. Cc: Krzysztof Kozlowski Cc: Rob Herring Cc: Cc: Benson Leung Cc: Guenter Roeck Reviewed-by: 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 Reported-by: Douglas Anderson --- drivers/input/keyboard/cros_ec_keyb.c | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/drivers/input/keyboard/cros_ec_keyb.c b/drivers/input/keyboard= /cros_ec_keyb.c index eef909e52e23..bdbb263e8586 100644 --- a/drivers/input/keyboard/cros_ec_keyb.c +++ b/drivers/input/keyboard/cros_ec_keyb.c @@ -464,8 +464,13 @@ static int cros_ec_keyb_register_bs(struct cros_ec_key= b *ckdev) return ret; switches =3D get_unaligned_le32(&event_data.switches); =20 - if (!buttons && !switches) + if (!buttons && !switches) { + /* Fail probe if we expected buttons/switches */ + if (of_device_is_compatible(dev->of_node, "google,cros-ec-keyb-switches"= )) + return -ENODEV; + return 0; + } =20 /* * We call the non-matrix buttons/switches 'input1', if present. @@ -536,14 +541,10 @@ static int cros_ec_keyb_register_matrix(struct cros_e= c_keyb *ckdev) u32 *physmap; u32 key_pos; unsigned int row, col, scancode, n_physmap; + bool has_keyboard; =20 - /* - * No rows and columns? There isn't a matrix but maybe there are - * switches to register in cros_ec_keyb_register_bs() because - * this is a detachable device. - */ - if (!device_property_present(dev, "keypad,num-rows") && - !device_property_present(dev, "keypad,num-cols")) + has_keyboard =3D device_get_match_data(dev); + if (!has_keyboard) return 0; =20 err =3D matrix_keypad_parse_properties(dev, &ckdev->rows, &ckdev->cols); @@ -718,8 +719,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