From patchwork Wed Dec 29 23:11:37 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dmitry Antipov X-Patchwork-Id: 528899 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 348A4C433FE for ; Wed, 29 Dec 2021 23:11:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232816AbhL2XLs (ORCPT ); Wed, 29 Dec 2021 18:11:48 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36210 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232503AbhL2XLs (ORCPT ); Wed, 29 Dec 2021 18:11:48 -0500 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 EB893C061574 for ; Wed, 29 Dec 2021 15:11:47 -0800 (PST) Received: by mail-pj1-x1035.google.com with SMTP id o63-20020a17090a0a4500b001b1c2db8145so25963844pjo.5 for ; Wed, 29 Dec 2021 15:11:47 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=gK3QhbqsrCSB4ia/eFNGHJP5DFriGyiBNNm22UgD4nc=; b=J4GZCnpblUiazrPbyn8HGytYVysfnebPlVEAdvjYROIsEBTL4Uw5o/D1VxVCi2lqHt 5JWY9aSpM3DNZdLzcZe6H+g2/5ztUV5659PrU3QXO0BHU8tWSKPcSSYl40KXiwyMruQ8 WMqozDBXGKkA4D/JStpbn3X2My71X5Q8aFoQwoJEFvi7YQqljlP4MCNRNZucQmY0REV9 mKuhvwjj752B9/h1cyYinu5XPPArWLqPaZOodx+lbg1Wg23J2G0UyuivjMhsTymz9bBH BWl/dNexr3Bm4cA4fl7jJNsSVAHrZjY+PftRzwxAHd4zUERm5qPc46fIIyc1frLdr5d3 vLIQ== 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=gK3QhbqsrCSB4ia/eFNGHJP5DFriGyiBNNm22UgD4nc=; b=I/AfIQnGS5SUqZYGOfVdsffpA/4zv5j0kgW7AaTG62L35CgPKBGV8U6u806Z0WbnxH AMyTCiTnx1X+FXOtmi3M3emRCR34u0huVPQI+g7GNQlO5o89hBD7F5SuDc7518OqlV1u 88lU28Cyk4zBdNY0IA1cldf1BUiJYAwICnV0bGnbJqEIvofuUnHBqWh1oPdpnmqgaAup OPGN+58K/QMGZPNMqvu46qteNNws82sgL2KTtx2RbpnKNK8Ftm26GjFPDJUgkTNkFFAI ozMHMAT+jWievDC2LAG3UWUKZ1o0zpyIFksbOXMAYlbfEQ6jrD8ZWBlOxfHTczrsfVrD OVhA== X-Gm-Message-State: AOAM530IjnHZON1bcrku+X7UePcNW5Qb6NupDhFza9/Gy29FCVJbKxMb VogVMLY5LOklvIVLHpSebCQ= X-Google-Smtp-Source: ABdhPJzHoVvBfLhkVcGvKGdzUBXa8lDOCueAbAcIMowl3uXpQV/Tjb0tJyQ3M0xsiiJjG3eeIbSPaw== X-Received: by 2002:a17:90b:38c9:: with SMTP id nn9mr34918725pjb.153.1640819507161; Wed, 29 Dec 2021 15:11:47 -0800 (PST) Received: from thelio.corp.microsoft.com ([2001:4898:80e8:36:99f0:adae:413c:2890]) by smtp.gmail.com with ESMTPSA id k6sm26058042pff.106.2021.12.29.15.11.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Dec 2021 15:11:46 -0800 (PST) From: Dmitry Antipov X-Google-Original-From: Dmitry Antipov To: Jiri Kosina , Benjamin Tissoires Cc: linux-input@vger.kernel.org, Felipe Balbi , Dmitry Antipov Subject: [PATCH v1 1/5] HID: Add BUS_SPI support when printing out device info in hid_connect() Date: Wed, 29 Dec 2021 15:11:37 -0800 Message-Id: <20211229231141.303919-2-dmanti@microsoft.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211229231141.303919-1-dmanti@microsoft.com> References: <20211229231141.303919-1-dmanti@microsoft.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org If connecting a hid_device with bus field indicating BUS_SPI print out "SPI" in the debug print. Signed-off-by: Dmitry Antipov Reviewed-by: Benjamin Tissoires --- drivers/hid/hid-core.c | 3 +++ 1 file changed, 3 insertions(+) diff --git a/drivers/hid/hid-core.c b/drivers/hid/hid-core.c index dbed2524fd47..65350ad985fe 100644 --- a/drivers/hid/hid-core.c +++ b/drivers/hid/hid-core.c @@ -2005,6 +2005,9 @@ int hid_connect(struct hid_device *hdev, unsigned int connect_mask) case BUS_I2C: bus = "I2C"; break; + case BUS_SPI: + bus = "SPI"; + break; case BUS_VIRTUAL: bus = "VIRTUAL"; break; From patchwork Wed Dec 29 23:11:38 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dmitry Antipov X-Patchwork-Id: 529589 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 91B29C433EF for ; Wed, 29 Dec 2021 23:11:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232832AbhL2XLt (ORCPT ); Wed, 29 Dec 2021 18:11:49 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36212 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232503AbhL2XLs (ORCPT ); Wed, 29 Dec 2021 18:11:48 -0500 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 AB303C061574 for ; Wed, 29 Dec 2021 15:11:48 -0800 (PST) Received: by mail-pf1-x429.google.com with SMTP id b22so19766950pfb.5 for ; Wed, 29 Dec 2021 15:11:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=TU3SXYPGHkZwAGgoAUbnOzsERn3Da3EDEy4rF+dH45Y=; b=GRY6dq0VO7x4fit/vG117y01KZVn6yOzORJG/aKvYnOEyO+VsQgZ1rrKZVkFIjxZaV utAGc+AGUWe90KpKzJax73p2ZDC66WFW3r83oQ3Mvm/ExhO3DWc8regl64czaPo7VPRn vPGYyjKTqndTf4bQa8ZYgAcDqKHMdqpzjGN49epu0wzRKy/1dbnizaQZ25SsxhXAri9J Em8fMgQ43hn/sJS1b7b1ixpgfya1/3kRmyIvYXo74G13yFHNV9rQHeCrM3UActOpGeOc fiNgvB6lbSm71w2AhBlGsO1AqUAy1ZQTcBQIuZZf9Wi4C7a1bATzl8gRs/bSCwnRKeTN S+DA== 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=TU3SXYPGHkZwAGgoAUbnOzsERn3Da3EDEy4rF+dH45Y=; b=8BROwZtoBXfUHoDQxzjDGk5SOtjPyOUbc8UlQWMnvJz/qlr+RHViHqUQDog9DM78a3 7Un9OfgtuYDwBlraFMzdroHnLuGa8GC2gJgPdC83eSoUFDWInMU283zlYb7OcqSnJOgn g+sAWX8fg2gsJQq6OmDMjDtME8LzKLSx8cpqqd/zNSXMs+fLg+K9p2DBNw1Sozq4mVEx aRfEtIJLp+cKd3kKfTWb2wQAHcUMXnge8FSLZ7N5yy6Jm0tp/rWPFSnrW9t/Q8wNpLdk dYZ+m6XZrGgwgSikFnexM5YPqIFVRcfggio2J0OavhcRw3AW52SUi6gHqSkTGu8X/vDv 2f8Q== X-Gm-Message-State: AOAM530wunKtWQbRLL74MtrHrPg81BayBg3NsaiRwyPHUvDCP4xE1/gr PG6i1tQzwq+Hr14WsSVE0pI= X-Google-Smtp-Source: ABdhPJwYu+yvnTATsaxru5KvaiewNlxdua3O6hsQ81LbMnfQLrSlip/5fD9OcuNMfIUi/h86s7y36w== X-Received: by 2002:a63:7408:: with SMTP id p8mr20357172pgc.73.1640819508197; Wed, 29 Dec 2021 15:11:48 -0800 (PST) Received: from thelio.corp.microsoft.com ([2001:4898:80e8:36:99f0:adae:413c:2890]) by smtp.gmail.com with ESMTPSA id k6sm26058042pff.106.2021.12.29.15.11.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Dec 2021 15:11:47 -0800 (PST) From: Dmitry Antipov X-Google-Original-From: Dmitry Antipov To: Jiri Kosina , Benjamin Tissoires Cc: linux-input@vger.kernel.org, Felipe Balbi , Dmitry Antipov Subject: [PATCH v1 2/5] HID: define HID_SPI_DEVICE macro in hid.h Date: Wed, 29 Dec 2021 15:11:38 -0800 Message-Id: <20211229231141.303919-3-dmanti@microsoft.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211229231141.303919-1-dmanti@microsoft.com> References: <20211229231141.303919-1-dmanti@microsoft.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org Macro sets the bus field to BUS_SPI and uses arguments to set vendor product fields. Signed-off-by: Dmitry Antipov --- include/linux/hid.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/include/linux/hid.h b/include/linux/hid.h index f453be385bd4..1f134c8f8972 100644 --- a/include/linux/hid.h +++ b/include/linux/hid.h @@ -684,6 +684,8 @@ struct hid_descriptor { .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod) #define HID_I2C_DEVICE(ven, prod) \ .bus = BUS_I2C, .vendor = (ven), .product = (prod) +#define HID_SPI_DEVICE(ven, prod) \ + .bus = BUS_SPI, .vendor = (ven), .product = (prod) #define HID_REPORT_ID(rep) \ .report_type = (rep) From patchwork Wed Dec 29 23:11:39 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dmitry Antipov X-Patchwork-Id: 528898 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 B8FE7C4332F for ; Wed, 29 Dec 2021 23:11:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232834AbhL2XLu (ORCPT ); Wed, 29 Dec 2021 18:11:50 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36220 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232503AbhL2XLt (ORCPT ); Wed, 29 Dec 2021 18:11:49 -0500 Received: from mail-pf1-x42d.google.com (mail-pf1-x42d.google.com [IPv6:2607:f8b0:4864:20::42d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AF434C061574 for ; Wed, 29 Dec 2021 15:11:49 -0800 (PST) Received: by mail-pf1-x42d.google.com with SMTP id c2so19782044pfc.1 for ; Wed, 29 Dec 2021 15:11:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=RFp2MDYzW2/VigGy5tzYr/UX0VyoGb2WGJDLoT34mrc=; b=WqogX1xyu263v6Jr3TYuXmVFOgKbtJCWvaEbzB/f9BMRoz8/SH7ZVi7+MkTvvKihT/ Ktx6vZGcbenSWLX9d9gKxfHfZpOVN6mbo6hYPE7gPKmEy6sGziE2dT22oIQjEcRa8QWA llF3Zr5VdY/bqjiamx/ZpEvxi8Q0dlyJ+kyZNT8cFhonQjspf0JBjVF3nTWzHUjYirMO vrVgsh5FAUPuL4c5k3qn/rtGw7wvWGNti5xKoekSjUjLykxeYQJL4a3lvKj8b50a+0mQ t76FWwzWOOUTUZKQuPyrCQ9i50JrIt9DxnbTeToVA+1UULcftRKe0Kvf6E2BGSqa9mbb GLOA== 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=RFp2MDYzW2/VigGy5tzYr/UX0VyoGb2WGJDLoT34mrc=; b=3AKhPbD5OjSv9BsFGCgACFjew/fFn4ydJPi0Qn2qkeWgwoaQztZc/QbKntR8dpwc58 O0fJIrH91ypVkP+8kqab07avy/dwAXwudXASEYiejYYOUZ4+zX0DprRwMjKX0+rBVDcm Ljv1o7JBOB+nlRO4pbgfYiS12K6WwRilroBAILXHZRcYchP2OkuuKzAD6XK/gzJ1VvgQ 7CvZewujWqf0Oi8eb4hJYoLpXA51gvpglb5L9XNmTegTOEqWwOVLuprZKDYpa83NXLg9 OLvR3TQsPC3QqurAQIgImlQi/uxTxUiNIyj6g0SnR1eiW1afqS+3Nawv1IPR1IEVuM9D ygnw== X-Gm-Message-State: AOAM53054/rmPgSdVOk/x4I41x1mh04GLwZ7tf4n16Wjyz3a+ivw56k2 K5/Hb5Fsvk5cAAu4boVafvb65eL2I2Q= X-Google-Smtp-Source: ABdhPJxIOoEtLNfk8HKEJsVZyD4Iqpoma1yVaABMIsnpj8pQnGv6V1zgz7oGRepB1w6Go6WNVgv7Kw== X-Received: by 2002:a63:8441:: with SMTP id k62mr25352564pgd.152.1640819509224; Wed, 29 Dec 2021 15:11:49 -0800 (PST) Received: from thelio.corp.microsoft.com ([2001:4898:80e8:36:99f0:adae:413c:2890]) by smtp.gmail.com with ESMTPSA id k6sm26058042pff.106.2021.12.29.15.11.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Dec 2021 15:11:49 -0800 (PST) From: Dmitry Antipov X-Google-Original-From: Dmitry Antipov To: Jiri Kosina , Benjamin Tissoires Cc: linux-input@vger.kernel.org, Felipe Balbi , Dmitry Antipov Subject: [PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver Date: Wed, 29 Dec 2021 15:11:39 -0800 Message-Id: <20211229231141.303919-4-dmanti@microsoft.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211229231141.303919-1-dmanti@microsoft.com> References: <20211229231141.303919-1-dmanti@microsoft.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org This new API allows a transport driver to notify the HID device driver about a transport layer error. Signed-off-by: Dmitry Antipov --- include/linux/hid.h | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/include/linux/hid.h b/include/linux/hid.h index 1f134c8f8972..97041c322a0f 100644 --- a/include/linux/hid.h +++ b/include/linux/hid.h @@ -703,6 +703,20 @@ struct hid_usage_id { __u32 usage_code; }; +enum hid_transport_error_type { + HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_START = 0, + HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_BODY, + HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_HEADER, + HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER, + HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET, + HID_TRANSPORT_ERROR_TYPE_HEADER_DATA, + HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA, + HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE, + HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE, + HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE, + HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE +}; + /** * struct hid_driver * @name: driver name (e.g. "Footech_bar-wheel") @@ -726,6 +740,7 @@ struct hid_usage_id { * @suspend: invoked on suspend (NULL means nop) * @resume: invoked on resume if device was not reset (NULL means nop) * @reset_resume: invoked on resume if device was reset (NULL means nop) + * @on_transport_error: invoked on error hit by transport driver * * probe should return -errno on error, or 0 on success. During probe, * input will not be passed to raw_event unless hid_device_io_start is @@ -777,6 +792,10 @@ struct hid_driver { void (*feature_mapping)(struct hid_device *hdev, struct hid_field *field, struct hid_usage *usage); + void (*on_transport_error)(struct hid_device *hdev, + int err_type, + int err_code, + bool handled); #ifdef CONFIG_PM int (*suspend)(struct hid_device *hdev, pm_message_t message); int (*resume)(struct hid_device *hdev); From patchwork Wed Dec 29 23:11:40 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dmitry Antipov X-Patchwork-Id: 529588 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 88D83C433EF for ; Wed, 29 Dec 2021 23:11:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232838AbhL2XLv (ORCPT ); Wed, 29 Dec 2021 18:11:51 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36224 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232503AbhL2XLu (ORCPT ); Wed, 29 Dec 2021 18:11:50 -0500 Received: from mail-pf1-x42b.google.com (mail-pf1-x42b.google.com [IPv6:2607:f8b0:4864:20::42b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 923E5C061574 for ; Wed, 29 Dec 2021 15:11:50 -0800 (PST) Received: by mail-pf1-x42b.google.com with SMTP id 205so19835293pfu.0 for ; Wed, 29 Dec 2021 15:11:50 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=N54ev01xH0LWpbzHLPnoCuVgibRhcgrefU0ixCvRe0c=; b=D9tBVbqS6T312w3IRLQX7tCygv6msBlq9Pt8jx54eG7UbQZ+meaVLynDpXtTNe4ueC CU0U3WZqxo/i+RTe5hS1kc7ICJWLEDgyGI7YoPIWGUw6SX2leHboUX3XNxMNWkcxauEn B1SkQC9BbSwyYU29ZP/B+l3DqXrrWtuHv/aGlONvi0Snrf+auI0rDoQvlT+Qkwjq8lZu FowYpbIWdoy6XPIhi1lbc57IB788kxq7llRWXSuTLlZzrWIY062PtZv5VoO4rmshBFa4 IJRLZS1Yf4u9Og0mWXPzv6qkQWWv9M6Jz20PASQKQvQ4ZAsLGKMJSU5C7+DNJ3JVCwQO 3Ogg== 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=N54ev01xH0LWpbzHLPnoCuVgibRhcgrefU0ixCvRe0c=; b=E01rO5uzrk3m5V80WTspMkkq51Q2l1cLJrzcawWMOJFXx3s4JtZEuyuKs+IxTe7/RH 0oVoGwJ43f0AQPW+sOwOKeL0x2Uql5WZoMbjm4k/mhXSTNr0rMO6ScdwetpDWiX44wct D8CeT7VXk+MGhf46oOyXFSID/eyZtOtQfGrPxEysIQAWAJZJIgRxaTS9pYv4p1kvHKAj IghIEwtgqgUuu4WC2H2rXXty4cOuHrK96cpqOmGydzL/96chUOY73Ts0nuAONeRgzESK RpoU5UKvVtKsNi1XnWMS3W3XrLaw7W0LFmqYp/7O2FQFbSaytWgoB0o1VG7b9l64a93R Bnmw== X-Gm-Message-State: AOAM5303ek8Xrc5AjPsdChnHUYLBXEozGZVwgJzjBy/y1zDL86MGHw8I ZUEM0c/m4bFp85OAQfuy/f4= X-Google-Smtp-Source: ABdhPJzC7og/7cFgrSJMq2g4S3SS55KSS9XUrp1KdEAf8MwdYNG2RWnhbx32+/R1QPPFc2o2hn7PEw== X-Received: by 2002:a63:e651:: with SMTP id p17mr25762593pgj.233.1640819510142; Wed, 29 Dec 2021 15:11:50 -0800 (PST) Received: from thelio.corp.microsoft.com ([2001:4898:80e8:36:99f0:adae:413c:2890]) by smtp.gmail.com with ESMTPSA id k6sm26058042pff.106.2021.12.29.15.11.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Dec 2021 15:11:49 -0800 (PST) From: Dmitry Antipov X-Google-Original-From: Dmitry Antipov To: Jiri Kosina , Benjamin Tissoires Cc: linux-input@vger.kernel.org, Felipe Balbi , Dmitry Antipov Subject: [PATCH v1 4/5] HID: add reset() field to struct hid_ll_driver Date: Wed, 29 Dec 2021 15:11:40 -0800 Message-Id: <20211229231141.303919-5-dmanti@microsoft.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211229231141.303919-1-dmanti@microsoft.com> References: <20211229231141.303919-1-dmanti@microsoft.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org This new API allows a device driver to reset the device. Signed-off-by: Dmitry Antipov --- include/linux/hid.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/linux/hid.h b/include/linux/hid.h index 97041c322a0f..129b542e1adb 100644 --- a/include/linux/hid.h +++ b/include/linux/hid.h @@ -823,6 +823,7 @@ struct hid_driver { * @output_report: send output report to device * @idle: send idle request to device * @may_wakeup: return if device may act as a wakeup source during system-suspend + * @reset: reset the device */ struct hid_ll_driver { int (*start)(struct hid_device *hdev); @@ -848,6 +849,8 @@ struct hid_ll_driver { int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype); bool (*may_wakeup)(struct hid_device *hdev); + + void (*reset)(struct hid_device *hdev); }; extern struct hid_ll_driver i2c_hid_ll_driver; From patchwork Wed Dec 29 23:11:41 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dmitry Antipov X-Patchwork-Id: 528897 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 BB7CEC433EF for ; Wed, 29 Dec 2021 23:11:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232842AbhL2XLx (ORCPT ); Wed, 29 Dec 2021 18:11:53 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36232 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232503AbhL2XLw (ORCPT ); Wed, 29 Dec 2021 18:11:52 -0500 Received: from mail-pj1-x1031.google.com (mail-pj1-x1031.google.com [IPv6:2607:f8b0:4864:20::1031]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 42CA6C061574 for ; Wed, 29 Dec 2021 15:11:52 -0800 (PST) Received: by mail-pj1-x1031.google.com with SMTP id f18-20020a17090aa79200b001ad9cb23022so21118416pjq.4 for ; Wed, 29 Dec 2021 15:11:52 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=n+LLsx05PabnDFLsSIEju23wxbiTD1P9C2mPPIXDVwY=; b=qNPhQmXfoLNPWKkQYHlLq91kIH0DicYzz24RHX/e5KnstCgwf914AV1tDcMSjnvhso TbVXVLKOoM/2qNk9IbiDklxYDYNUnFGQbtvJf/79vghjSaX1AdVk9PBiBtLlQc4Ildrc u6JMjJdVYBaXZWJ2Bl3bjswoUC7ZTLz9/VtPbq4R+wlr1xF0GPgXaHn1fd+fR2O7cXfs Gfqg7E+0zAJZVDjJx/xP4AHo5xc89xR1uf26Z6Og8Fkr6iA+jjPLTT3F9hlZQ9r1kcjh Ntk5Dy3eHVneilc/ld7pxXPpWveA3byc1xOilgJ8HZfJeo6rTpv0p/HGaRAHaQbZT28E OTXA== 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=n+LLsx05PabnDFLsSIEju23wxbiTD1P9C2mPPIXDVwY=; b=D1Tq3qOAegCvTHaYyJyGbDwDjIL2So73QgS8tO4H9uQ2jf3ciXv2GP8lECPxTOkZ13 E3KUAlR9izzI/fYs63kUzKmkkVAgJ20k0da9JxLKVYJYHq9D8Ts0eFYFvvrnZk5gQ3pi dcLxitBTRjn1wPMvqE/lxX3TxQD4Lrn9CXzAgKg9Wtfh7sLm6ifPlCoP8LbAXZ9DXmaY R92wgXZqMzR/osoYl12aVfM7gXG6ACkCzMRS/DsxpG6lw0yI06WcXDEISmvOpA1XBCPQ 6qgRQhu7IBU21VZ9XDCefuIlx9gsm+t5WfCHjZ8nKjTD3RRQJ+gsCqmdnMzh/G715GAE xomQ== X-Gm-Message-State: AOAM531RlwyT1YzDX/qJpZbTzR9whrzv3xc4joCR7y2WMA6NfxLEQFWe XOSOt88H1Q5mfX5oCrpTFPpfUMT7QVg= X-Google-Smtp-Source: ABdhPJzDfiBGORmQGhiDk2VqkC0oCZ8yaTuHghh+6keJeJyAbUhXd+MW4jz4Oo6lQCoIqhK4fvzxbQ== X-Received: by 2002:a17:902:6a88:b0:149:848f:1e8b with SMTP id n8-20020a1709026a8800b00149848f1e8bmr15002296plk.124.1640819511523; Wed, 29 Dec 2021 15:11:51 -0800 (PST) Received: from thelio.corp.microsoft.com ([2001:4898:80e8:36:99f0:adae:413c:2890]) by smtp.gmail.com with ESMTPSA id k6sm26058042pff.106.2021.12.29.15.11.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 29 Dec 2021 15:11:51 -0800 (PST) From: Dmitry Antipov X-Google-Original-From: Dmitry Antipov To: Jiri Kosina , Benjamin Tissoires Cc: linux-input@vger.kernel.org, Felipe Balbi , Dmitry Antipov Subject: [PATCH v1 5/5] HID: add spi-hid, transport driver for HID over SPI bus Date: Wed, 29 Dec 2021 15:11:41 -0800 Message-Id: <20211229231141.303919-6-dmanti@microsoft.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211229231141.303919-1-dmanti@microsoft.com> References: <20211229231141.303919-1-dmanti@microsoft.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org This driver follows the HID Over SPI Protocol Specification 1.0. The initial version of the driver does not support: 1) multi-fragment input reports, 2) sending GET_INPUT and COMMAND output report types and processing their respective acknowledge input reports, and 3) device sleep power state. Signed-off-by: Dmitry Antipov --- arch/arm64/configs/defconfig | 1 + drivers/hid/Kconfig | 2 + drivers/hid/Makefile | 1 + drivers/hid/spi-hid/Kconfig | 25 + drivers/hid/spi-hid/Makefile | 12 + drivers/hid/spi-hid/spi-hid-core.c | 1487 +++++++++++++++++++++++++++ drivers/hid/spi-hid/spi-hid-core.h | 201 ++++ drivers/hid/spi-hid/spi-hid_trace.h | 197 ++++ drivers/hid/spi-hid/trace.c | 11 + 9 files changed, 1937 insertions(+) create mode 100644 drivers/hid/spi-hid/Kconfig create mode 100644 drivers/hid/spi-hid/Makefile create mode 100644 drivers/hid/spi-hid/spi-hid-core.c create mode 100644 drivers/hid/spi-hid/spi-hid-core.h create mode 100644 drivers/hid/spi-hid/spi-hid_trace.h create mode 100644 drivers/hid/spi-hid/trace.c diff --git a/arch/arm64/configs/defconfig b/arch/arm64/configs/defconfig index f2e2b9bdd702..25249a4b0c8a 100644 --- a/arch/arm64/configs/defconfig +++ b/arch/arm64/configs/defconfig @@ -805,6 +805,7 @@ CONFIG_SND_AUDIO_GRAPH_CARD=m CONFIG_HID_MULTITOUCH=m CONFIG_I2C_HID_ACPI=m CONFIG_I2C_HID_OF=m +CONFIG_SPI_HID=m CONFIG_USB_CONN_GPIO=m CONFIG_USB=y CONFIG_USB_OTG=y diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig index a7c78ac96270..cd2c10703fcf 100644 --- a/drivers/hid/Kconfig +++ b/drivers/hid/Kconfig @@ -1262,6 +1262,8 @@ source "drivers/hid/usbhid/Kconfig" source "drivers/hid/i2c-hid/Kconfig" +source "drivers/hid/spi-hid/Kconfig" + source "drivers/hid/intel-ish-hid/Kconfig" source "drivers/hid/amd-sfh-hid/Kconfig" diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile index 55a6fa3eca5a..caf418dda343 100644 --- a/drivers/hid/Makefile +++ b/drivers/hid/Makefile @@ -144,6 +144,7 @@ obj-$(CONFIG_USB_MOUSE) += usbhid/ obj-$(CONFIG_USB_KBD) += usbhid/ obj-$(CONFIG_I2C_HID_CORE) += i2c-hid/ +obj-$(CONFIG_SPI_HID) += spi-hid/ obj-$(CONFIG_INTEL_ISH_HID) += intel-ish-hid/ obj-$(INTEL_ISH_FIRMWARE_DOWNLOADER) += intel-ish-hid/ diff --git a/drivers/hid/spi-hid/Kconfig b/drivers/hid/spi-hid/Kconfig new file mode 100644 index 000000000000..5b34e51edc76 --- /dev/null +++ b/drivers/hid/spi-hid/Kconfig @@ -0,0 +1,25 @@ +# +# Copyright (c) 2021 Microsoft Corporation +# +# This program is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License version 2 as published by +# the Free Software Foundation. +# +menu "SPI HID support" + depends on SPI + +config SPI_HID + tristate "HID over SPI transport layer" + default n + depends on SPI && INPUT + select HID + help + Say Y here if you use a keyboard, a touchpad, a touchscreen, or any + other HID based devices which is connected to your computer via SPI. + + If unsure, say N. + + This support is also available as a module. If so, the module + will be called spi-hid. + +endmenu diff --git a/drivers/hid/spi-hid/Makefile b/drivers/hid/spi-hid/Makefile new file mode 100644 index 000000000000..5eae49219ab5 --- /dev/null +++ b/drivers/hid/spi-hid/Makefile @@ -0,0 +1,12 @@ +# +# Copyright (c) 2021 Microsoft Corporation +# +# This program is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License version 2 as published by +# the Free Software Foundation. +# +# Makefile for the SPI input drivers +# +CFLAGS_trace.o = -I$(src) +obj-$(CONFIG_SPI_HID) += spi-hid.o +spi-hid-objs := spi-hid-core.o trace.o diff --git a/drivers/hid/spi-hid/spi-hid-core.c b/drivers/hid/spi-hid/spi-hid-core.c new file mode 100644 index 000000000000..e672bbc30b26 --- /dev/null +++ b/drivers/hid/spi-hid/spi-hid-core.c @@ -0,0 +1,1487 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * HID over SPI protocol implementation + * spi-hid-core.h + * + * Copyright (c) 2021 Microsoft Corporation + * + * This code is partly based on "HID over I2C protocol implementation: + * + * Copyright (c) 2012 Benjamin Tissoires + * Copyright (c) 2012 Ecole Nationale de l'Aviation Civile, France + * Copyright (c) 2012 Red Hat, Inc + * + * which in turn is partly based on "USB HID support for Linux": + * + * Copyright (c) 1999 Andreas Gal + * Copyright (c) 2000-2005 Vojtech Pavlik + * Copyright (c) 2005 Michael Haboustak for Concept2, Inc + * Copyright (c) 2007-2008 Oliver Neukum + * Copyright (c) 2006-2010 Jiri Kosina + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published by + * the Free Software Foundation. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "spi-hid-core.h" +#include "spi-hid_trace.h" +#include "../hid-ids.h" + +#define SPI_HID_MAX_RESET_ATTEMPTS 3 + +static struct hid_ll_driver spi_hid_ll_driver; + +static void spi_hid_populate_read_approvals(struct spi_hid_host_config *conf, + __u8 *header_buf, __u8 *body_buf) +{ + header_buf[0] = conf->read_opcode; + header_buf[1] = (conf->input_report_header_address >> 16) & 0xff; + header_buf[2] = (conf->input_report_header_address >> 8) & 0xff; + header_buf[3] = (conf->input_report_header_address >> 0) & 0xff; + header_buf[4] = SPI_HID_READ_APPROVAL_CONSTANT; + + body_buf[0] = conf->read_opcode; + body_buf[1] = (conf->input_report_body_address >> 16) & 0xff; + body_buf[2] = (conf->input_report_body_address >> 8) & 0xff; + body_buf[3] = (conf->input_report_body_address >> 0) & 0xff; + body_buf[4] = SPI_HID_READ_APPROVAL_CONSTANT; +} + +static void spi_hid_parse_dev_desc(struct spi_hid_device_desc_raw *raw, + struct spi_hid_device_descriptor *desc) +{ + desc->hid_version = le16_to_cpu(raw->bcdVersion); + desc->report_descriptor_length = le16_to_cpu(raw->wReportDescLength); + desc->max_input_length = le16_to_cpu(raw->wMaxInputLength); + desc->max_output_length = le16_to_cpu(raw->wMaxOutputLength); + + /* FIXME: multi-fragment not supported, field below not used */ + desc->max_fragment_length = le16_to_cpu(raw->wMaxFragmentLength); + + desc->vendor_id = le16_to_cpu(raw->wVendorID); + desc->product_id = le16_to_cpu(raw->wProductID); + desc->version_id = le16_to_cpu(raw->wVersionID); + desc->no_output_report_ack = le16_to_cpu(raw->wFlags) & BIT(0); +} + +static void spi_hid_populate_input_header(__u8 *buf, + struct spi_hid_input_header *header) +{ + header->version = buf[0] & 0xf; + header->report_length = (buf[1] | ((buf[2] & 0x3f) << 8)) * 4; + header->last_fragment_flag = (buf[2] & 0x40) >> 6; + header->sync_const = buf[3]; +} + +static void spi_hid_populate_input_body(__u8 *buf, + struct spi_hid_input_body *body) +{ + body->report_type = buf[0]; + body->content_length = buf[1] | (buf[2] << 8); + body->content_id = buf[3]; +} + +static void spi_hid_input_report_prepare(struct spi_hid_input_buf *buf, + struct spi_hid_input_report *report) +{ + struct spi_hid_input_header header; + struct spi_hid_input_body body; + + spi_hid_populate_input_header(buf->header, &header); + spi_hid_populate_input_body(buf->body, &body); + report->report_type = body.report_type; + report->content_length = body.content_length; + report->content_id = body.content_id; + report->content = buf->content; +} + +static void spi_hid_populate_output_header(__u8 *buf, + struct spi_hid_host_config *conf, + struct spi_hid_output_report *report) +{ + buf[0] = conf->write_opcode; + buf[1] = (conf->output_report_address >> 16) & 0xff; + buf[2] = (conf->output_report_address >> 8) & 0xff; + buf[3] = (conf->output_report_address >> 0) & 0xff; + buf[4] = report->report_type; + buf[5] = report->content_length & 0xff; + buf[6] = (report->content_length >> 8) & 0xff; + buf[7] = report->content_id; +} + +static int spi_hid_input_async(struct spi_hid *shid, void *buf, u16 length, + void (*complete)(void *), bool is_header) +{ + int ret; + struct device *dev = &shid->spi->dev; + + shid->input_transfer[0].tx_buf = is_header ? shid->read_approval_header : + shid->read_approval_body; + shid->input_transfer[0].len = SPI_HID_READ_APPROVAL_LEN; + + shid->input_transfer[1].rx_buf = buf; + shid->input_transfer[1].len = length; + + spi_message_init_with_transfers(&shid->input_message, + shid->input_transfer, 2); + + shid->input_message.complete = complete; + shid->input_message.context = shid; + + trace_spi_hid_input_async(shid, + shid->input_transfer[0].tx_buf, + shid->input_transfer[0].len, + shid->input_transfer[1].rx_buf, + shid->input_transfer[1].len, 0); + + ret = spi_async(shid->spi, &shid->input_message); + if (ret) { + dev_err(dev, "Error starting async transfer: %d, resetting\n", + ret); + schedule_work(&shid->error_work); + + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_START; + shid->notify_device_driver_error_code = ret; + shid->notify_device_driver_handled = true; + schedule_work(&shid->notify_device_driver_work); + } + + return ret; +} + +static int spi_hid_output(struct spi_hid *shid, void *buf, u16 length) +{ + struct spi_transfer transfer; + struct spi_message message; + int ret; + + memset(&transfer, 0, sizeof(transfer)); + + transfer.tx_buf = buf; + transfer.len = length; + + spi_message_init_with_transfers(&message, &transfer, 1); + + /* + * REVISIT: Should output be asynchronous? + * + * According to Documentation/hid/hid-transport.rst, ->output_report() + * must be implemented as an asynchronous operation. + */ + trace_spi_hid_output_begin(shid, transfer.tx_buf, + transfer.len, NULL, 0, 0); + + ret = spi_sync(shid->spi, &message); + + trace_spi_hid_output_end(shid, transfer.tx_buf, + transfer.len, NULL, 0, ret); + + if (ret) { + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER; + shid->notify_device_driver_error_code = ret; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + } + + return ret; +} + +static const char *const spi_hid_power_mode_string(u8 power_state) +{ + switch (power_state) { + case SPI_HID_POWER_MODE_ON: + return "d0"; + case SPI_HID_POWER_MODE_SLEEP: + return "d2"; + case SPI_HID_POWER_MODE_OFF: + return "d3"; + case SPI_HID_POWER_MODE_WAKING_SLEEP: + return "d3*"; + default: + return "unknown"; + } +} + +static int spi_hid_power_down(struct spi_hid *shid) +{ + struct device *dev = &shid->spi->dev; + int ret; + + if (regulator_is_enabled(shid->supply) == 0) + return 0; + + ret = regulator_disable(shid->supply); + if (ret) { + dev_err(dev, "failed to disable regulator\n"); + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE; + shid->notify_device_driver_error_code = ret; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + return ret; + } + + return 0; +} + +static int spi_hid_power_up(struct spi_hid *shid) +{ + int ret; + + if (regulator_is_enabled(shid->supply) > 0) + return 0; + + ret = regulator_enable(shid->supply); + if (ret) { + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE; + shid->notify_device_driver_error_code = ret; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + } + + /* FIXME: timeout values should come from DT */ + usleep_range(5000, 6000); + + return ret; +} + +static void spi_hid_suspend(struct spi_hid *shid) +{ + struct device *dev = &shid->spi->dev; + + if (shid->power_state == SPI_HID_POWER_MODE_OFF) + return; + + disable_irq(shid->spi->irq); + shid->ready = false; + sysfs_notify(&dev->kobj, NULL, "ready"); + + gpiod_set_value(shid->reset_gpio, 1); + + shid->power_state = SPI_HID_POWER_MODE_OFF; +} + +static void spi_hid_resume(struct spi_hid *shid) +{ + if (shid->power_state == SPI_HID_POWER_MODE_ON) + return; + + shid->power_state = SPI_HID_POWER_MODE_ON; + enable_irq(shid->spi->irq); + shid->input_transfer_pending = 0; + + gpiod_set_value(shid->reset_gpio, 0); + + /* FIXME: timeout values should come from DT */ + usleep_range(5000, 6000); +} + +static struct hid_device *spi_hid_disconnect_hid(struct spi_hid *shid) +{ + struct hid_device *hid = shid->hid; + + shid->hid = NULL; + + return hid; +} + +static void spi_hid_stop_hid(struct spi_hid *shid) +{ + struct hid_device *hid; + + hid = spi_hid_disconnect_hid(shid); + if (hid) { + cancel_work_sync(&shid->create_device_work); + cancel_work_sync(&shid->refresh_device_work); + hid_destroy_device(hid); + } +} + +static void spi_hid_error_handler(struct spi_hid *shid) +{ + struct device *dev = &shid->spi->dev; + + if (shid->power_state == SPI_HID_POWER_MODE_OFF) + return; + + dev_err(dev, "Error Handler\n"); + + if (shid->attempts++ >= SPI_HID_MAX_RESET_ATTEMPTS) { + dev_err(dev, "unresponsive device, aborting.\n"); + spi_hid_stop_hid(shid); + gpiod_set_value(shid->reset_gpio, 1); + spi_hid_power_down(shid); + return; + } + + shid->ready = false; + sysfs_notify(&dev->kobj, NULL, "ready"); + + gpiod_set_value(shid->reset_gpio, 1); + + shid->power_state = SPI_HID_POWER_MODE_OFF; + shid->input_transfer_pending = 0; + cancel_work_sync(&shid->reset_work); + + /* FIXME: timeout values should come from DT */ + msleep(100); + + shid->power_state = SPI_HID_POWER_MODE_ON; + + gpiod_set_value(shid->reset_gpio, 0); +} + +static void spi_hid_error_work(struct work_struct *work) +{ + struct spi_hid *shid = container_of(work, struct spi_hid, error_work); + + spi_hid_error_handler(shid); +} + +static void spi_hid_notify_device_driver_work(struct work_struct *work) +{ + struct spi_hid *shid = container_of(work, struct spi_hid, + notify_device_driver_work); + + if (shid->hid && shid->hid->driver && + shid->hid->driver->on_transport_error) { + shid->hid->driver->on_transport_error(shid->hid, + shid->notify_device_driver_error_type, + shid->notify_device_driver_error_code, + shid->notify_device_driver_handled); + } +} + +static int spi_hid_send_output_report(struct spi_hid *shid, + struct spi_hid_output_report *report) +{ + struct spi_hid_output_buf *buf = &shid->output; + struct device *dev = &shid->spi->dev; + u16 report_length; + u16 padded_length; + u8 padding; + int ret; + + if (report->content_length > shid->desc.max_output_length) { + dev_err(dev, "Output report too big, content_length 0x%x\n", + report->content_length); + ret = -E2BIG; + goto out; + } + + spi_hid_populate_output_header(buf->header, &shid->conf, report); + + if (report->content_length) + memcpy(&buf->content, report->content, report->content_length); + + report_length = sizeof(buf->header) + report->content_length; + padded_length = round_up(report_length, 4); + padding = padded_length - report_length; + memset(&buf->content[report->content_length], 0, padding); + + ret = spi_hid_output(shid, buf, padded_length); + if (ret) { + dev_err(dev, "Failed output transfer\n"); + goto out; + } + + return 0; + +out: + return ret; +} + +static int spi_hid_sync_request(struct spi_hid *shid, + struct spi_hid_output_report *report) +{ + struct device *dev = &shid->spi->dev; + int ret = 0; + + ret = spi_hid_send_output_report(shid, report); + if (ret) { + dev_err(dev, "Failed to transfer output report\n"); + return ret; + } + + mutex_unlock(&shid->lock); + ret = wait_for_completion_interruptible_timeout(&shid->output_done, + msecs_to_jiffies(1000)); + mutex_lock(&shid->lock); + if (ret == 0) { + dev_err(dev, "Response timed out\n"); + return -ETIMEDOUT; + } + + return 0; +} + +/** + * Handle the reset response from the FW by sending a request for the device + * descriptor. + */ +static void spi_hid_reset_work(struct work_struct *work) +{ + struct spi_hid *shid = + container_of(work, struct spi_hid, reset_work); + struct device *dev = &shid->spi->dev; + struct spi_hid_output_report report = { + .report_type = SPI_HID_OUTPUT_REPORT_TYPE_DEVICE_DESC_REQUEST, + .content_length = 0x0, + .content_id = SPI_HID_OUTPUT_REPORT_CONTENT_ID_DESC_REQUEST, + .content = NULL, + }; + int ret; + + trace_spi_hid_reset_work(shid); + + dev_dbg(dev, "Reset Handler\n"); + + if (shid->ready) { + dev_err(dev, "Spontaneous FW reset!"); + shid->ready = false; + sysfs_notify(&dev->kobj, NULL, "ready"); + + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET; + shid->notify_device_driver_error_code = 0; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + } + + if (shid->power_state == SPI_HID_POWER_MODE_OFF) + return; + + if (flush_work(&shid->create_device_work)) + dev_err(dev, "Reset handler waited for create_device_work"); + + if (flush_work(&shid->refresh_device_work)) + dev_err(dev, "Reset handler waited for refresh_device_work"); + + mutex_lock(&shid->lock); + ret = spi_hid_sync_request(shid, &report); + mutex_unlock(&shid->lock); + if (ret) { + dev_WARN_ONCE(dev, true, + "Failed to send device descriptor request\n"); + spi_hid_error_handler(shid); + } +} + +static int spi_hid_input_report_handler(struct spi_hid *shid, + struct spi_hid_input_buf *buf) +{ + struct device *dev = &shid->spi->dev; + struct spi_hid_input_report r; + int ret; + + dev_dbg(dev, "Input Report Handler\n"); + + trace_spi_hid_input_report_handler(shid); + + if (!shid->ready) { + dev_err(dev, "discarding input report, not ready!\n"); + return 0; + } + + if (shid->refresh_in_progress) { + dev_err(dev, "discarding input report, refresh in progress!\n"); + return 0; + } + + if (!shid->hid) { + dev_err(dev, "discarding input report, no HID device!\n"); + return 0; + } + + spi_hid_input_report_prepare(buf, &r); + + ret = hid_input_report(shid->hid, HID_INPUT_REPORT, + r.content - 1, + r.content_length + 1, 1); + + if (ret == -ENODEV || ret == -EBUSY) { + dev_err(dev, "ignoring report --> %d\n", ret); + return 0; + } else if (ret) { + dev_err(dev, "Bad input report, error %d\n", ret); + } + + return ret; +} + +static void spi_hid_response_handler(struct spi_hid *shid, + struct spi_hid_input_buf *buf) +{ + trace_spi_hid_response_handler(shid); + dev_dbg(&shid->spi->dev, "Response Handler\n"); + + /* completion_done returns 0 if there are waiters, otherwise 1 */ + if (completion_done(&shid->output_done)) { + dev_err(&shid->spi->dev, "Unexpected response report\n"); + } else { + if (shid->input.body[0] == + SPI_HID_INPUT_REPORT_TYPE_REPORT_DESC || + shid->input.body[0] == + SPI_HID_INPUT_REPORT_TYPE_GET_FEATURE_RESP) { + size_t response_length = (shid->input.body[1] | + (shid->input.body[2] << 8)) + + sizeof(shid->input.body); + memcpy(shid->response.body, shid->input.body, + response_length); + } + complete(&shid->output_done); + } +} + +/* + * This function returns the length of the report descriptor, or a negative + * error code if something went wrong. + */ +static int spi_hid_report_descriptor_request(struct spi_hid *shid) +{ + int ret; + struct device *dev = &shid->spi->dev; + struct spi_hid_output_report report = { + .report_type = SPI_HID_OUTPUT_REPORT_TYPE_REPORT_DESC_REQUEST, + .content_length = 0, + .content_id = SPI_HID_OUTPUT_REPORT_CONTENT_ID_DESC_REQUEST, + .content = NULL, + }; + + ret = spi_hid_sync_request(shid, &report); + if (ret) { + dev_err(dev, + "Expected report descriptor not received! Error %d\n", + ret); + spi_hid_error_handler(shid); + goto out; + } + + ret = (shid->response.body[1] | (shid->response.body[2] << 8)); + if (ret != shid->desc.report_descriptor_length) { + dev_err(dev, + "Received report descriptor length doesn't match device descriptor field, using min of the two\n"); + ret = min_t(unsigned int, ret, + shid->desc.report_descriptor_length); + } +out: + return ret; +} + +static void spi_hid_process_input_report(struct spi_hid *shid, + struct spi_hid_input_buf *buf) +{ + struct spi_hid_input_header header; + struct spi_hid_input_body body; + struct device *dev = &shid->spi->dev; + struct spi_hid_device_desc_raw *raw; + int ret; + + trace_spi_hid_process_input_report(shid); + + spi_hid_populate_input_header(buf->header, &header); + spi_hid_populate_input_body(buf->body, &body); + + dev_WARN_ONCE(dev, body.content_length > header.report_length, + "Bad body length %d > %d\n", + body.content_length, header.report_length); + + switch (body.report_type) { + case SPI_HID_INPUT_REPORT_TYPE_DATA: + ret = spi_hid_input_report_handler(shid, buf); + if (ret) { + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA; + shid->notify_device_driver_error_code = ret; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + } + break; + case SPI_HID_INPUT_REPORT_TYPE_RESET_RESP: + schedule_work(&shid->reset_work); + break; + case SPI_HID_INPUT_REPORT_TYPE_DEVICE_DESC: + dev_dbg(dev, "Received device descriptor\n"); + /* Mark the completion done to avoid timeout */ + spi_hid_response_handler(shid, buf); + + /* Reset attempts at every device descriptor fetch */ + shid->attempts = 0; + + raw = (struct spi_hid_device_desc_raw *)buf->content; + + /* Validate device descriptor length before parsing */ + if (body.content_length != SPI_HID_DEVICE_DESCRIPTOR_LENGTH) { + dev_err(dev, + "Invalid content length %d, expected %d\n", + body.content_length, + SPI_HID_DEVICE_DESCRIPTOR_LENGTH); + schedule_work(&shid->error_work); + break; + } + + if (le16_to_cpu(raw->wDeviceDescLength) != + SPI_HID_DEVICE_DESCRIPTOR_LENGTH) { + dev_err(dev, + "Invalid wDeviceDescLength %d, expected %d\n", + raw->wDeviceDescLength, + SPI_HID_DEVICE_DESCRIPTOR_LENGTH); + schedule_work(&shid->error_work); + break; + } + + spi_hid_parse_dev_desc(raw, &shid->desc); + + if (shid->desc.hid_version != SPI_HID_SUPPORTED_VERSION) { + dev_err(dev, + "Unsupported device descriptor version %4x\n", + shid->desc.hid_version); + schedule_work(&shid->error_work); + break; + } + + if (!shid->hid) + schedule_work(&shid->create_device_work); + else + schedule_work(&shid->refresh_device_work); + + break; + case SPI_HID_INPUT_REPORT_TYPE_SET_OUTPUT_REPORT_RESP: + if (shid->desc.no_output_report_ack) { + dev_err(dev, "Unexpected output report response\n"); + break; + } + fallthrough; + case SPI_HID_INPUT_REPORT_TYPE_GET_FEATURE_RESP: + case SPI_HID_INPUT_REPORT_TYPE_SET_FEATURE_RESP: + if (!shid->ready) { + dev_err(dev, + "Unexpected response report while not ready: 0x%x\n", + body.report_type); + break; + } + fallthrough; + case SPI_HID_INPUT_REPORT_TYPE_REPORT_DESC: + spi_hid_response_handler(shid, buf); + break; + /* + * FIXME: sending GET_INPUT and COMMAND reports not supported, thus + * throw away responses to those, they should never come. + */ + case SPI_HID_INPUT_REPORT_TYPE_GET_INPUT_REPORT_RESP: + case SPI_HID_INPUT_REPORT_TYPE_COMMAND_RESP: + dev_err(dev, "Not a supported report type: 0x%x\n", + body.report_type); + break; + default: + dev_err(dev, "Unknown input report: 0x%x\n", + body.report_type); + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE; + shid->notify_device_driver_error_code = -EPROTO; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + break; + } +} + +static int spi_hid_bus_validate_header(struct spi_hid *shid, + struct spi_hid_input_header *header) +{ + struct device *dev = &shid->spi->dev; + + if (header->version != SPI_HID_INPUT_HEADER_VERSION) { + dev_err(dev, "Unknown input report version (v 0x%x)\n", + header->version); + return -EINVAL; + } + + if (shid->desc.max_input_length != 0 && + header->report_length > shid->desc.max_input_length) { + dev_err(dev, "Input report body size %u > max expected of %u\n", + header->report_length, + shid->desc.max_input_length); + return -EMSGSIZE; + } + + if (header->last_fragment_flag != 1) { + dev_err(dev, "Multi-fragment reports not supported\n"); + return -EOPNOTSUPP; + } + + if (header->sync_const != SPI_HID_INPUT_HEADER_SYNC_BYTE) { + dev_err(dev, "Invalid input report sync constant (0x%x)\n", + header->sync_const); + return -EINVAL; + } + + return 0; +} + +static int spi_hid_create_device(struct spi_hid *shid) +{ + struct hid_device *hid; + struct device *dev = &shid->spi->dev; + int ret; + + hid = hid_allocate_device(); + + if (IS_ERR(hid)) { + dev_err(dev, "Failed to allocate hid device: %ld\n", + PTR_ERR(hid)); + ret = PTR_ERR(hid); + return ret; + } + + hid->driver_data = shid->spi; + hid->ll_driver = &spi_hid_ll_driver; + hid->dev.parent = &shid->spi->dev; + hid->bus = BUS_SPI; + hid->version = shid->desc.hid_version; + hid->vendor = shid->desc.vendor_id; + hid->product = shid->desc.product_id; + + snprintf(hid->name, sizeof(hid->name), "spi %04hX:%04hX", + hid->vendor, hid->product); + strscpy(hid->phys, dev_name(&shid->spi->dev), sizeof(hid->phys)); + + shid->hid = hid; + + ret = hid_add_device(hid); + if (ret) { + dev_err(dev, "Failed to add hid device: %d\n", ret); + /* + * We likely got here because report descriptor request timed + * out. Let's disconnect and destroy the hid_device structure. + */ + hid = spi_hid_disconnect_hid(shid); + if (hid) + hid_destroy_device(hid); + return ret; + } + + return 0; +} + +static void spi_hid_create_device_work(struct work_struct *work) +{ + struct spi_hid *shid = + container_of(work, struct spi_hid, create_device_work); + struct device *dev = &shid->spi->dev; + u8 prev_state = shid->power_state; + int ret; + + trace_spi_hid_create_device_work(shid); + dev_dbg(dev, "Create device work\n"); + + ret = spi_hid_create_device(shid); + if (ret) { + dev_err(dev, "Failed to create hid device\n"); + return; + } + + spi_hid_suspend(shid); + + shid->attempts = 0; + + dev_err(dev, "%s: %s -> %s\n", __func__, + spi_hid_power_mode_string(prev_state), + spi_hid_power_mode_string(shid->power_state)); +} + +static void spi_hid_refresh_device_work(struct work_struct *work) +{ + struct spi_hid *shid = + container_of(work, struct spi_hid, refresh_device_work); + struct device *dev = &shid->spi->dev; + struct hid_device *hid; + int ret; + u32 new_crc32; + + trace_spi_hid_refresh_device_work(shid); + dev_dbg(dev, "Refresh device work\n"); + + mutex_lock(&shid->lock); + ret = spi_hid_report_descriptor_request(shid); + mutex_unlock(&shid->lock); + if (ret < 0) { + dev_err(dev, + "Refresh: failed report descriptor request, error %d", + ret); + return; + } + + new_crc32 = crc32_le(0, (unsigned char const *)shid->response.content, + (size_t)ret); + if (new_crc32 == shid->report_descriptor_crc32) { + dev_dbg(dev, "Refresh device work - returning\n"); + shid->ready = true; + sysfs_notify(&dev->kobj, NULL, "ready"); + return; + } + + dev_err(dev, "Re-creating the HID device\n"); + + shid->report_descriptor_crc32 = new_crc32; + shid->refresh_in_progress = true; + + hid = spi_hid_disconnect_hid(shid); + if (hid) + hid_destroy_device(hid); + + ret = spi_hid_create_device(shid); + if (ret) + dev_err(dev, "Failed to create hid device\n"); + + shid->refresh_in_progress = false; + shid->ready = true; + sysfs_notify(&dev->kobj, NULL, "ready"); +} + +static void spi_hid_input_header_complete(void *_shid); + +static void spi_hid_input_body_complete(void *_shid) +{ + struct spi_hid *shid = _shid; + struct device *dev = &shid->spi->dev; + unsigned long flags; + int ret; + + spin_lock_irqsave(&shid->input_lock, flags); + + if (shid->power_state == SPI_HID_POWER_MODE_OFF) { + dev_warn(dev, + "input body complete called while device is off\n"); + goto out; + } + + trace_spi_hid_input_body_complete(shid, + shid->input_transfer[0].tx_buf, + shid->input_transfer[0].len, + shid->input_transfer[1].rx_buf, + shid->input_transfer[1].len, + shid->input_message.status); + + if (shid->input_message.status < 0) { + dev_warn(dev, "error reading body, resetting %d\n", + shid->input_message.status); + schedule_work(&shid->error_work); + + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_BODY; + shid->notify_device_driver_error_code = + shid->input_message.status; + shid->notify_device_driver_handled = true; + schedule_work(&shid->notify_device_driver_work); + goto out; + } + + spi_hid_process_input_report(shid, &shid->input); + + if (--shid->input_transfer_pending) { + struct spi_hid_input_buf *buf = &shid->input; + + trace_spi_hid_header_transfer(shid); + ret = spi_hid_input_async(shid, buf->header, + sizeof(buf->header), + spi_hid_input_header_complete, true); + if (ret) + dev_err(dev, "failed to start header transfer %d\n", + ret); + } + +out: + spin_unlock_irqrestore(&shid->input_lock, flags); +} + +static void spi_hid_input_header_complete(void *_shid) +{ + struct spi_hid *shid = _shid; + struct device *dev = &shid->spi->dev; + struct spi_hid_input_header header; + unsigned long flags; + int ret = 0; + + spin_lock_irqsave(&shid->input_lock, flags); + + if (shid->power_state == SPI_HID_POWER_MODE_OFF) { + dev_warn(dev, + "input header complete called while device is off\n"); + goto out; + } + + trace_spi_hid_input_header_complete(shid, + shid->input_transfer[0].tx_buf, + shid->input_transfer[0].len, + shid->input_transfer[1].rx_buf, + shid->input_transfer[1].len, + shid->input_message.status); + + if (shid->input_message.status < 0) { + dev_warn(dev, "error reading header, resetting, error %d\n", + shid->input_message.status); + schedule_work(&shid->error_work); + + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_HEADER; + shid->notify_device_driver_error_code = + shid->input_message.status; + shid->notify_device_driver_handled = true; + schedule_work(&shid->notify_device_driver_work); + goto out; + } + spi_hid_populate_input_header(shid->input.header, &header); + + ret = spi_hid_bus_validate_header(shid, &header); + if (ret) { + dev_err(dev, "failed to validate header: %d\n", ret); + print_hex_dump(KERN_ERR, "spi_hid: header buffer: ", + DUMP_PREFIX_NONE, 16, 1, + shid->input.header, + sizeof(shid->input.header), + false); + + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_HEADER_DATA; + shid->notify_device_driver_error_code = ret; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + goto out; + } + + ret = spi_hid_input_async(shid, shid->input.body, header.report_length, + spi_hid_input_body_complete, false); + if (ret) + dev_err(dev, "failed body async transfer: %d\n", ret); + +out: + if (ret) + shid->input_transfer_pending = 0; + + spin_unlock_irqrestore(&shid->input_lock, flags); +} + +static int spi_hid_get_request(struct spi_hid *shid, u8 content_id) +{ + int ret; + struct device *dev = &shid->spi->dev; + struct spi_hid_output_report report = { + .report_type = SPI_HID_OUTPUT_REPORT_TYPE_HID_GET_FEATURE, + .content_length = 0, + .content_id = content_id, + .content = NULL, + }; + + ret = spi_hid_sync_request(shid, &report); + if (ret) { + dev_err(dev, + "Expected get request response not received! Error %d\n", + ret); + shid->notify_device_driver_error_type = + HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE; + shid->notify_device_driver_error_code = ret; + shid->notify_device_driver_handled = false; + schedule_work(&shid->notify_device_driver_work); + } + + return ret; +} + +static int spi_hid_set_request(struct spi_hid *shid, + u8 *arg_buf, u16 arg_len, u8 content_id) +{ + struct spi_hid_output_report report = { + .report_type = SPI_HID_OUTPUT_REPORT_TYPE_HID_SET_FEATURE, + .content_length = arg_len, + .content_id = content_id, + .content = arg_buf, + }; + + return spi_hid_sync_request(shid, &report); +} + +static irqreturn_t spi_hid_dev_irq(int irq, void *_shid) +{ + struct spi_hid *shid = _shid; + struct device *dev = &shid->spi->dev; + int ret = 0; + + spin_lock(&shid->input_lock); + trace_spi_hid_dev_irq(shid, irq); + + if (shid->input_transfer_pending++) + goto out; + + trace_spi_hid_header_transfer(shid); + ret = spi_hid_input_async(shid, shid->input.header, + sizeof(shid->input.header), + spi_hid_input_header_complete, true); + if (ret) + dev_err(dev, "Failed to start header transfer: %d\n", ret); + +out: + spin_unlock(&shid->input_lock); + + return IRQ_HANDLED; +} + +/* hid_ll_driver interface functions */ + +static int spi_hid_ll_start(struct hid_device *hid) +{ + struct spi_device *spi = hid->driver_data; + struct spi_hid *shid = spi_get_drvdata(spi); + + if (shid->desc.max_input_length < HID_MIN_BUFFER_SIZE) { + dev_err(&shid->spi->dev, + "HID_MIN_BUFFER_SIZE > max_input_length (%d)\n", + shid->desc.max_input_length); + return -EINVAL; + } + + return 0; +} + +static void spi_hid_ll_stop(struct hid_device *hid) +{ + hid->claimed = 0; +} + +static int spi_hid_ll_open(struct hid_device *hid) +{ + struct spi_device *spi = hid->driver_data; + struct spi_hid *shid = spi_get_drvdata(spi); + struct device *dev = &spi->dev; + u8 prev_state = shid->power_state; + + if (shid->refresh_in_progress) + return 0; + + spi_hid_resume(shid); + + dev_err(dev, "%s: %s -> %s\n", __func__, + spi_hid_power_mode_string(prev_state), + spi_hid_power_mode_string(shid->power_state)); + + return 0; +} + +static void spi_hid_ll_close(struct hid_device *hid) +{ + struct spi_device *spi = hid->driver_data; + struct spi_hid *shid = spi_get_drvdata(spi); + struct device *dev = &spi->dev; + u8 prev_state = shid->power_state; + + if (shid->refresh_in_progress) + return; + + spi_hid_suspend(shid); + + shid->attempts = 0; + + dev_err(dev, "%s: %s -> %s\n", __func__, + spi_hid_power_mode_string(prev_state), + spi_hid_power_mode_string(shid->power_state)); +} + +static int spi_hid_ll_power(struct hid_device *hid, int level) +{ + struct spi_device *spi = hid->driver_data; + struct spi_hid *shid = spi_get_drvdata(spi); + int ret = 0; + + mutex_lock(&shid->lock); + if (!shid->hid) + ret = -ENODEV; + mutex_unlock(&shid->lock); + + return ret; +} + +static int spi_hid_ll_parse(struct hid_device *hid) +{ + struct spi_device *spi = hid->driver_data; + struct spi_hid *shid = spi_get_drvdata(spi); + struct device *dev = &spi->dev; + int ret, len; + + mutex_lock(&shid->lock); + + len = spi_hid_report_descriptor_request(shid); + if (len < 0) { + dev_err(dev, "Report descriptor request failed, %d\n", len); + ret = len; + goto out; + } + + /* + * FIXME: below call returning 0 doesn't mean that the report descriptor + * is good. We might be caching a crc32 of a corrupted r. d. or who + * knows what the FW sent. Need to have a feedback loop about r. d. + * being ok and only then cache it. + */ + ret = hid_parse_report(hid, (__u8 *)shid->response.content, len); + if (ret) + dev_err(dev, "failed parsing report: %d\n", ret); + else + shid->report_descriptor_crc32 = crc32_le(0, + (unsigned char const *)shid->response.content, + len); + +out: + mutex_unlock(&shid->lock); + + return ret; +} + +static int spi_hid_ll_raw_request(struct hid_device *hid, + unsigned char reportnum, __u8 *buf, size_t len, + unsigned char rtype, int reqtype) +{ + struct spi_device *spi = hid->driver_data; + struct spi_hid *shid = spi_get_drvdata(spi); + struct device *dev = &spi->dev; + int ret; + + if (!shid->ready) { + dev_err(&shid->spi->dev, "%s called in unready state\n", + __func__); + return -ENODEV; + } + + mutex_lock(&shid->lock); + + switch (reqtype) { + case HID_REQ_SET_REPORT: + if (buf[0] != reportnum) { + dev_err(dev, "report id mismatch\n"); + ret = -EINVAL; + break; + } + + ret = spi_hid_set_request(shid, &buf[1], len - 1, + reportnum); + if (ret) { + dev_err(dev, "failed to set report\n"); + break; + } + + ret = len; + break; + case HID_REQ_GET_REPORT: + ret = spi_hid_get_request(shid, reportnum); + if (ret) { + dev_err(dev, "failed to get report\n"); + break; + } + + ret = min_t(size_t, len, + shid->response.body[1] | (shid->response.body[2] << 8)); + memcpy(buf, &shid->response.content, ret); + break; + default: + dev_err(dev, "invalid request type\n"); + ret = -EIO; + } + + mutex_unlock(&shid->lock); + + return ret; +} + +static int spi_hid_ll_output_report(struct hid_device *hid, + __u8 *buf, size_t len) +{ + int ret; + struct spi_device *spi = hid->driver_data; + struct spi_hid *shid = spi_get_drvdata(spi); + struct device *dev = &spi->dev; + struct spi_hid_output_report report = { + .report_type = SPI_HID_OUTPUT_REPORT_TYPE_HID_OUTPUT_REPORT, + .content_length = len - 1, + .content_id = buf[0], + .content = &buf[1], + }; + + mutex_lock(&shid->lock); + if (!shid->ready) { + dev_err(dev, "%s called in unready state\n", __func__); + ret = -ENODEV; + goto out; + } + + if (shid->desc.no_output_report_ack) + ret = spi_hid_send_output_report(shid, &report); + else + ret = spi_hid_sync_request(shid, &report); + + if (ret) + dev_err(dev, "failed to send output report\n"); + +out: + mutex_unlock(&shid->lock); + + if (ret > 0) + return -ret; + + if (ret < 0) + return ret; + + return len; +} + +void spi_hid_ll_reset(struct hid_device *hid) +{ + struct spi_device *spi = hid->driver_data; + struct device *dev = &spi->dev; + struct spi_hid *shid = spi_get_drvdata(spi); + + dev_err(dev, "%s()\n", __func__); + spi_hid_error_handler(shid); +} + +static struct hid_ll_driver spi_hid_ll_driver = { + .start = spi_hid_ll_start, + .stop = spi_hid_ll_stop, + .open = spi_hid_ll_open, + .close = spi_hid_ll_close, + .power = spi_hid_ll_power, + .parse = spi_hid_ll_parse, + .output_report = spi_hid_ll_output_report, + .raw_request = spi_hid_ll_raw_request, + .reset = spi_hid_ll_reset +}; + +static const struct of_device_id spi_hid_of_match[] = { + { .compatible = "hid-over-spi" }, + {}, +}; +MODULE_DEVICE_TABLE(of, spi_hid_of_match); + +static ssize_t ready_show(struct device *dev, + struct device_attribute *attr, char *buf) +{ + struct spi_hid *shid = dev_get_drvdata(dev); + + return snprintf(buf, PAGE_SIZE, "%s\n", + shid->ready ? "ready" : "not ready"); +} +static DEVICE_ATTR_RO(ready); + +static const struct attribute *const spi_hid_attributes[] = { + &dev_attr_ready.attr, + NULL /* Terminator */ +}; + +static int spi_hid_probe(struct spi_device *spi) +{ + struct device *dev = &spi->dev; + struct spi_hid *shid; + unsigned long irqflags; + int ret; + u32 val; + + if (spi->irq <= 0) { + dev_err(dev, "Missing IRQ\n"); + ret = spi->irq ?: -EINVAL; + goto err0; + } + + shid = devm_kzalloc(dev, sizeof(struct spi_hid), GFP_KERNEL); + if (!shid) { + ret = -ENOMEM; + goto err0; + } + + shid->spi = spi; + shid->power_state = SPI_HID_POWER_MODE_ON; + spi_set_drvdata(spi, shid); + + ret = sysfs_create_files(&dev->kobj, spi_hid_attributes); + if (ret) { + dev_err(dev, "Unable to create sysfs attributes\n"); + goto err0; + } + + ret = device_property_read_u32(dev, "input-report-header-address", + &val); + if (ret) { + dev_err(dev, "Input report header address not provided\n"); + ret = -ENODEV; + goto err1; + } + shid->conf.input_report_header_address = val; + + ret = device_property_read_u32(dev, "input-report-body-address", &val); + if (ret) { + dev_err(dev, "Input report body address not provided\n"); + ret = -ENODEV; + goto err1; + } + shid->conf.input_report_body_address = val; + + ret = device_property_read_u32(dev, "output-report-address", &val); + if (ret) { + dev_err(dev, "Output report address not provided\n"); + ret = -ENODEV; + goto err1; + } + shid->conf.output_report_address = val; + + ret = device_property_read_u32(dev, "read-opcode", &val); + if (ret) { + dev_err(dev, "Read opcode not provided\n"); + ret = -ENODEV; + goto err1; + } + shid->conf.read_opcode = val; + + ret = device_property_read_u32(dev, "write-opcode", &val); + if (ret) { + dev_err(dev, "Write opcode not provided\n"); + ret = -ENODEV; + goto err1; + } + shid->conf.write_opcode = val; + + /* FIXME: not reading flags from DT, multi-SPI modes not supported */ + + /* Using now populated conf let's pre-calculate the read approvals */ + spi_hid_populate_read_approvals(&shid->conf, shid->read_approval_header, + shid->read_approval_body); + + mutex_init(&shid->lock); + init_completion(&shid->output_done); + + shid->supply = devm_regulator_get(dev, "vdd"); + if (IS_ERR(shid->supply)) { + if (PTR_ERR(shid->supply) != -EPROBE_DEFER) + dev_err(dev, "Failed to get regulator: %ld\n", + PTR_ERR(shid->supply)); + ret = PTR_ERR(shid->supply); + goto err1; + } + + spin_lock_init(&shid->input_lock); + INIT_WORK(&shid->reset_work, spi_hid_reset_work); + INIT_WORK(&shid->create_device_work, spi_hid_create_device_work); + INIT_WORK(&shid->refresh_device_work, spi_hid_refresh_device_work); + INIT_WORK(&shid->error_work, spi_hid_error_work); + INIT_WORK(&shid->notify_device_driver_work, + spi_hid_notify_device_driver_work); + + /* + * At the end of probe we initialize the device: + * 0) Default pinctrl in DT: assert reset, bias the interrupt line + * 1) sleep 100ms + * 2) request IRQ + * 3) power up the device + * 4) sleep 5ms + * 5) deassert reset (high) + * 6) sleep 5ms + */ + + shid->reset_gpio = gpiod_get(dev, "ms_g6_reset_gpio", GPIOD_OUT_LOW); + if (IS_ERR(shid->reset_gpio)) { + dev_err(dev, "%s: error getting GPIO\n", __func__); + goto err1; + } + + /* FIXME: timeout values should come from DT */ + msleep(100); + + irqflags = irq_get_trigger_type(spi->irq) | IRQF_ONESHOT; + ret = request_irq(spi->irq, spi_hid_dev_irq, irqflags, + dev_name(&spi->dev), shid); + if (ret) + goto err1; + + ret = spi_hid_power_up(shid); + if (ret) { + dev_err(dev, "%s: could not power up\n", __func__); + goto err1; + } + + gpiod_set_value(shid->reset_gpio, 0); + + /* FIXME: timeout values should come from DT */ + usleep_range(5000, 6000); + + dev_err(dev, "%s: d3 -> %s\n", __func__, + spi_hid_power_mode_string(shid->power_state)); + + return 0; + +err1: + sysfs_remove_files(&dev->kobj, spi_hid_attributes); + +err0: + return ret; +} + +static int spi_hid_remove(struct spi_device *spi) +{ + struct spi_hid *shid = spi_get_drvdata(spi); + struct device *dev = &spi->dev; + + gpiod_set_value(shid->reset_gpio, 1); + gpiod_put(shid->reset_gpio); + spi_hid_power_down(shid); + free_irq(spi->irq, shid); + sysfs_remove_files(&dev->kobj, spi_hid_attributes); + spi_hid_stop_hid(shid); + + return 0; +} + +static const struct spi_device_id spi_hid_id_table[] = { + { "hid", 0 }, + { "hid-over-spi", 0 }, + { }, +}; +MODULE_DEVICE_TABLE(spi, spi_hid_id_table); + +static struct spi_driver spi_hid_driver = { + .driver = { + .name = "spi_hid", + .owner = THIS_MODULE, + .of_match_table = of_match_ptr(spi_hid_of_match), + }, + .probe = spi_hid_probe, + .remove = spi_hid_remove, + .id_table = spi_hid_id_table, +}; + +module_spi_driver(spi_hid_driver); + +MODULE_DESCRIPTION("HID over SPI transport driver"); +MODULE_AUTHOR("Dmitry Antipov "); +MODULE_LICENSE("GPL"); diff --git a/drivers/hid/spi-hid/spi-hid-core.h b/drivers/hid/spi-hid/spi-hid-core.h new file mode 100644 index 000000000000..bb154162ff3e --- /dev/null +++ b/drivers/hid/spi-hid/spi-hid-core.h @@ -0,0 +1,201 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * spi-hid-core.h + * + * Copyright (c) 2021 Microsoft Corporation + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published by + * the Free Software Foundation. + */ + +#ifndef SPI_HID_CORE_H +#define SPI_HID_CORE_H + +#include +#include +#include +#include +#include + +/* Protocol constants */ +#define SPI_HID_READ_APPROVAL_CONSTANT 0xff +#define SPI_HID_INPUT_HEADER_SYNC_BYTE 0x5a +#define SPI_HID_INPUT_HEADER_VERSION 0x03 +#define SPI_HID_SUPPORTED_VERSION 0x0300 + +/* Protocol message size constants */ +#define SPI_HID_READ_APPROVAL_LEN 5 +#define SPI_HID_INPUT_HEADER_LEN 4 +#define SPI_HID_INPUT_BODY_LEN 4 +#define SPI_HID_OUTPUT_HEADER_LEN 8 +#define SPI_HID_DEVICE_DESCRIPTOR_LENGTH 24 + +/* Protocol message type constants */ +#define SPI_HID_INPUT_REPORT_TYPE_DATA 0x01 +#define SPI_HID_INPUT_REPORT_TYPE_RESET_RESP 0x03 +#define SPI_HID_INPUT_REPORT_TYPE_COMMAND_RESP 0x04 +#define SPI_HID_INPUT_REPORT_TYPE_GET_FEATURE_RESP 0x05 +#define SPI_HID_INPUT_REPORT_TYPE_DEVICE_DESC 0x07 +#define SPI_HID_INPUT_REPORT_TYPE_REPORT_DESC 0x08 +#define SPI_HID_INPUT_REPORT_TYPE_SET_FEATURE_RESP 0x09 +#define SPI_HID_INPUT_REPORT_TYPE_SET_OUTPUT_REPORT_RESP 0x0a +#define SPI_HID_INPUT_REPORT_TYPE_GET_INPUT_REPORT_RESP 0x0b + +#define SPI_HID_OUTPUT_REPORT_TYPE_DEVICE_DESC_REQUEST 0x01 +#define SPI_HID_OUTPUT_REPORT_TYPE_REPORT_DESC_REQUEST 0x02 +#define SPI_HID_OUTPUT_REPORT_TYPE_HID_SET_FEATURE 0x03 +#define SPI_HID_OUTPUT_REPORT_TYPE_HID_GET_FEATURE 0x04 +#define SPI_HID_OUTPUT_REPORT_TYPE_HID_OUTPUT_REPORT 0x05 +#define SPI_HID_OUTPUT_REPORT_TYPE_INPUT_REPORT_REQUEST 0x06 +#define SPI_HID_OUTPUT_REPORT_TYPE_COMMAND 0x07 + +#define SPI_HID_OUTPUT_REPORT_CONTENT_ID_DESC_REQUEST 0x00 + +/* Power mode constants */ +#define SPI_HID_POWER_MODE_ON 0x01 +#define SPI_HID_POWER_MODE_SLEEP 0x02 +#define SPI_HID_POWER_MODE_OFF 0x03 +#define SPI_HID_POWER_MODE_WAKING_SLEEP 0x04 + +/* Config structure is filled based on data from Device Tree */ +struct spi_hid_host_config { + u32 input_report_header_address; + u32 input_report_body_address; + u32 output_report_address; + u8 read_opcode; + u8 write_opcode; +}; + +/* Raw input buffer with data from the bus */ +struct spi_hid_input_buf { + __u8 header[SPI_HID_INPUT_HEADER_LEN]; + __u8 body[SPI_HID_INPUT_BODY_LEN]; + u8 content[SZ_8K]; +}; + +/* Processed data from input report header */ +struct spi_hid_input_header { + u8 version; + u16 report_length; + u8 last_fragment_flag; + u8 sync_const; +}; + +/* Processed data from input report body, excluding the content */ +struct spi_hid_input_body { + u8 report_type; + u16 content_length; + u8 content_id; +}; + +/* Processed data from an input report */ +struct spi_hid_input_report { + u8 report_type; + u16 content_length; + u8 content_id; + u8 *content; +}; + +/* Raw output report buffer to be put on the bus */ +struct spi_hid_output_buf { + __u8 header[SPI_HID_OUTPUT_HEADER_LEN]; + u8 content[SZ_8K]; +}; + +/* Data necessary to send an output report */ +struct spi_hid_output_report { + u8 report_type; + u16 content_length; + u8 content_id; + u8 *content; +}; + +/* Raw content in device descriptor */ +struct spi_hid_device_desc_raw { + __le16 wDeviceDescLength; + __le16 bcdVersion; + __le16 wReportDescLength; + __le16 wMaxInputLength; + __le16 wMaxOutputLength; + __le16 wMaxFragmentLength; + __le16 wVendorID; + __le16 wProductID; + __le16 wVersionID; + __le16 wFlags; + __u8 reserved[4]; +} __packed; + +/* Processed data from a device descriptor */ +struct spi_hid_device_descriptor { + u16 hid_version; + u16 report_descriptor_length; + u16 max_input_length; + u16 max_output_length; + u16 max_fragment_length; + u16 vendor_id; + u16 product_id; + u16 version_id; + u8 no_output_report_ack; +}; + +/* Driver context */ +struct spi_hid { + struct spi_device *spi; + struct hid_device *hid; + + struct spi_transfer input_transfer[2]; + struct spi_transfer output_transfer; + struct spi_message input_message; + struct spi_message output_message; + + struct spi_hid_host_config conf; + struct spi_hid_device_descriptor desc; + struct spi_hid_output_buf output; + struct spi_hid_input_buf input; + struct spi_hid_input_buf response; + + spinlock_t input_lock; + + u32 input_transfer_pending; + + u8 power_state; + + u8 attempts; + + /* + * ready flag indicates that the FW is ready to accept commands and + * requests. The FW becomes ready after sending the report descriptor. + */ + bool ready; + /* + * refresh_in_progress is set to true while the refresh_device worker + * thread is destroying and recreating the hidraw device. When this flag + * is set to true, the ll_close and ll_open functions will not cause + * power state changes + */ + bool refresh_in_progress; + + struct regulator *supply; + struct work_struct reset_work; + struct work_struct create_device_work; + struct work_struct refresh_device_work; + struct work_struct error_work; + struct work_struct notify_device_driver_work; + + int notify_device_driver_error_type; + int notify_device_driver_error_code; + bool notify_device_driver_handled; + + struct mutex lock; + struct completion output_done; + + __u8 read_approval_header[SPI_HID_READ_APPROVAL_LEN]; + __u8 read_approval_body[SPI_HID_READ_APPROVAL_LEN]; + + u32 report_descriptor_crc32; + + struct gpio_desc *reset_gpio; +}; + +#endif diff --git a/drivers/hid/spi-hid/spi-hid_trace.h b/drivers/hid/spi-hid/spi-hid_trace.h new file mode 100644 index 000000000000..60264bac0dc5 --- /dev/null +++ b/drivers/hid/spi-hid/spi-hid_trace.h @@ -0,0 +1,197 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * spi-hid_trace.h + * + * Copyright (c) 2021 Microsoft Corporation + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published by + * the Free Software Foundation. + */ + +#undef TRACE_SYSTEM +#define TRACE_SYSTEM spi_hid + +#if !defined(_SPI_HID_TRACE_H) || defined(TRACE_HEADER_MULTI_READ) +#define _SPI_HID_TRACE_H + +#include +#include +#include "spi-hid-core.h" + +DECLARE_EVENT_CLASS(spi_hid_transfer, + TP_PROTO(struct spi_hid *shid, const void *tx_buf, int tx_len, + const void *rx_buf, u16 rx_len, int ret), + + TP_ARGS(shid, tx_buf, tx_len, rx_buf, rx_len, ret), + + TP_STRUCT__entry( + __field(int, bus_num) + __field(int, chip_select) + __field(int, len) + __field(int, ret) + __dynamic_array(u8, rx_buf, rx_len) + __dynamic_array(u8, tx_buf, tx_len) + ), + + TP_fast_assign( + __entry->bus_num = shid->spi->controller->bus_num; + __entry->chip_select = shid->spi->chip_select; + __entry->len = rx_len + tx_len; + __entry->ret = ret; + + memcpy(__get_dynamic_array(tx_buf), tx_buf, tx_len); + memcpy(__get_dynamic_array(rx_buf), rx_buf, rx_len); + ), + + TP_printk("spi%d.%d: len=%d tx=[%*phD] rx=[%*phD] --> %d", + __entry->bus_num, __entry->chip_select, __entry->len, + __get_dynamic_array_len(tx_buf), __get_dynamic_array(tx_buf), + __get_dynamic_array_len(rx_buf), __get_dynamic_array(rx_buf), + __entry->ret) +); + +DEFINE_EVENT(spi_hid_transfer, spi_hid_input_async, + TP_PROTO(struct spi_hid *shid, const void *tx_buf, int tx_len, + const void *rx_buf, u16 rx_len, int ret), + TP_ARGS(shid, tx_buf, tx_len, rx_buf, rx_len, ret) +); + +DEFINE_EVENT(spi_hid_transfer, spi_hid_input_header_complete, + TP_PROTO(struct spi_hid *shid, const void *tx_buf, int tx_len, + const void *rx_buf, u16 rx_len, int ret), + TP_ARGS(shid, tx_buf, tx_len, rx_buf, rx_len, ret) +); + +DEFINE_EVENT(spi_hid_transfer, spi_hid_input_body_complete, + TP_PROTO(struct spi_hid *shid, const void *tx_buf, int tx_len, + const void *rx_buf, u16 rx_len, int ret), + TP_ARGS(shid, tx_buf, tx_len, rx_buf, rx_len, ret) +); + +DEFINE_EVENT(spi_hid_transfer, spi_hid_output_begin, + TP_PROTO(struct spi_hid *shid, const void *tx_buf, int tx_len, + const void *rx_buf, u16 rx_len, int ret), + TP_ARGS(shid, tx_buf, tx_len, rx_buf, rx_len, ret) +); + +DEFINE_EVENT(spi_hid_transfer, spi_hid_output_end, + TP_PROTO(struct spi_hid *shid, const void *tx_buf, int tx_len, + const void *rx_buf, u16 rx_len, int ret), + TP_ARGS(shid, tx_buf, tx_len, rx_buf, rx_len, ret) +); + +DECLARE_EVENT_CLASS(spi_hid_irq, + TP_PROTO(struct spi_hid *shid, int irq), + + TP_ARGS(shid, irq), + + TP_STRUCT__entry( + __field(int, bus_num) + __field(int, chip_select) + __field(int, irq) + ), + + TP_fast_assign( + __entry->bus_num = shid->spi->controller->bus_num; + __entry->chip_select = shid->spi->chip_select; + __entry->irq = irq; + ), + + TP_printk("spi%d.%d: IRQ %d", + __entry->bus_num, __entry->chip_select, __entry->irq) +); + +DEFINE_EVENT(spi_hid_irq, spi_hid_dev_irq, + TP_PROTO(struct spi_hid *shid, int irq), + TP_ARGS(shid, irq) +); + +DECLARE_EVENT_CLASS(spi_hid, + TP_PROTO(struct spi_hid *shid), + + TP_ARGS(shid), + + TP_STRUCT__entry( + __field(int, bus_num) + __field(int, chip_select) + __field(int, power_state) + __field(u32, input_transfer_pending) + __field(bool, ready) + + __field(int, vendor_id) + __field(int, product_id) + __field(int, max_input_length) + __field(int, max_output_length) + __field(u16, hid_version) + __field(u16, report_descriptor_length) + __field(u16, version_id) + ), + + TP_fast_assign( + __entry->bus_num = shid->spi->controller->bus_num; + __entry->chip_select = shid->spi->chip_select; + __entry->power_state = shid->power_state; + __entry->input_transfer_pending = shid->input_transfer_pending; + __entry->ready = shid->ready; + + __entry->vendor_id = shid->desc.vendor_id; + __entry->product_id = shid->desc.product_id; + __entry->max_input_length = shid->desc.max_input_length; + __entry->max_output_length = shid->desc.max_output_length; + __entry->hid_version = shid->desc.hid_version; + __entry->report_descriptor_length = + shid->desc.report_descriptor_length; + __entry->version_id = shid->desc.version_id; + ), + + TP_printk("spi%d.%d: (%04x:%04x v%d) HID v%d.%d state i:%d p:%d len i:%d o:%d r:%d flags %c:%d", + __entry->bus_num, __entry->chip_select, __entry->vendor_id, + __entry->product_id, __entry->version_id, + __entry->hid_version >> 8, __entry->hid_version & 0xff, + __entry->power_state, __entry->max_input_length, + __entry->max_output_length, __entry->report_descriptor_length, + __entry->ready ? 'R' : 'r', __entry->input_transfer_pending) +); + +DEFINE_EVENT(spi_hid, spi_hid_header_transfer, + TP_PROTO(struct spi_hid *shid), + TP_ARGS(shid) +); + +DEFINE_EVENT(spi_hid, spi_hid_process_input_report, + TP_PROTO(struct spi_hid *shid), + TP_ARGS(shid) +); + +DEFINE_EVENT(spi_hid, spi_hid_input_report_handler, + TP_PROTO(struct spi_hid *shid), + TP_ARGS(shid) +); + +DEFINE_EVENT(spi_hid, spi_hid_reset_work, + TP_PROTO(struct spi_hid *shid), + TP_ARGS(shid) +); + +DEFINE_EVENT(spi_hid, spi_hid_create_device_work, + TP_PROTO(struct spi_hid *shid), + TP_ARGS(shid) +); + +DEFINE_EVENT(spi_hid, spi_hid_refresh_device_work, + TP_PROTO(struct spi_hid *shid), + TP_ARGS(shid) +); + +DEFINE_EVENT(spi_hid, spi_hid_response_handler, + TP_PROTO(struct spi_hid *shid), + TP_ARGS(shid) +); + +#endif /* _SPI_HID_TRACE_H */ + +#undef TRACE_INCLUDE_PATH +#define TRACE_INCLUDE_PATH . +#define TRACE_INCLUDE_FILE spi-hid_trace +#include diff --git a/drivers/hid/spi-hid/trace.c b/drivers/hid/spi-hid/trace.c new file mode 100644 index 000000000000..7be35c8405df --- /dev/null +++ b/drivers/hid/spi-hid/trace.c @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: GPL-2.0 +/** + * trace.c - SPI HID Trace Support + * + * Copyright (C) 2021 Microsoft Corporation + * + * Author: Felipe Balbi + */ + +#define CREATE_TRACE_POINTS +#include "spi-hid_trace.h"