[PATCH v1 0/5] Add spi-hid, transport for HID over SPI bus

[PATCH v1 0/5] Add spi-hid, transport for HID over SPI bus

[Dmitry Antipov]

Surface Duo devices use a touch digitizer that communicates to the main
SoC via SPI and presents itself as a HID device. This patch's goal is to
add the spi-hid transport driver to drivers/hid. The driver follows the
publically available HID Over SPI Protocol Specification version 1.0.

In the initial commits there are some HID core changes to support a SPI
device, followed by extensions to hid_driver and hid_ll_driver structs
to allow for some error-handling logic delegation from the transport
layer to the device driver, and finally the SPI HID transport driver.

Dmitry Antipov (5):
  HID: Add BUS_SPI support when printing out device info in
    hid_connect()
  HID: define HID_SPI_DEVICE macro in hid.h
  HID: add on_transport_error() field to struct hid_driver
  HID: add reset() field to struct hid_ll_driver
  HID: add spi-hid, transport driver for HID over SPI bus

 arch/arm64/configs/defconfig        |    1 +
 drivers/hid/Kconfig                 |    2 +
 drivers/hid/Makefile                |    1 +
 drivers/hid/hid-core.c              |    3 +
 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 +
 include/linux/hid.h                 |   24 +
 11 files changed, 1964 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

-- 
2.25.1

[PATCH v1 1/5] HID: Add BUS_SPI support when printing out device info in hid_connect()

[Dmitry Antipov]

If connecting a hid_device with bus field indicating BUS_SPI print out
"SPI" in the debug print.

Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
---
 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;
-- 
2.25.1

Re: [PATCH v1 1/5] HID: Add BUS_SPI support when printing out device info in hid_connect()

[Benjamin Tissoires]

On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com> wrote:
>
> If connecting a hid_device with bus field indicating BUS_SPI print out
> "SPI" in the debug print.
>
> Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> ---

Reviewed-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>

Cheers,
Benjamin

>  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;
> --
> 2.25.1
>

[PATCH v1 2/5] HID: define HID_SPI_DEVICE macro in hid.h

[Dmitry Antipov]

Macro sets the bus field to BUS_SPI and uses arguments to set vendor
product fields.

Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
---
 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)
-- 
2.25.1

Re: [PATCH v1 2/5] HID: define HID_SPI_DEVICE macro in hid.h

[Benjamin Tissoires]

On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com> wrote:
>
> Macro sets the bus field to BUS_SPI and uses arguments to set vendor
> product fields.
>
> Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> ---

Reviewed-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>

Cheers,
Benjamin

>  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)
> --
> 2.25.1
>

[PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver

[Dmitry Antipov]

This new API allows a transport driver to notify the HID device driver
about a transport layer error.

Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
---
 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);
-- 
2.25.1

Re: [PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver

[Benjamin Tissoires]

On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com> wrote:
>
> This new API allows a transport driver to notify the HID device driver
> about a transport layer error.

I do not see entirely the purpose of this new callback:

- when we receive the device initiated reset, this is a specific
device event, so it would make sense...
- but for things like HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER, I
would expect the caller to return that error code instead of having an
async function called.

I think it might be simpler to add a more specific
.device_initiated_reset() callback instead of trying to be generic.

>
> Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> ---
>  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,

Those 3 enums above are completely SPI specifics, but they are
declared in the generic hid.h header.
Also, if I am a driver, what am I supposed to do when I receive such an error?
Up till now, the most we did was to raise a warning to the user, and
paper over it. I am open to some smarter behavior, but I do not see
what a mouse driver is supposed to do with that kind of error.

> +       HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,

Seems like this would better handled as a return code than an async callback

> +       HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET,

OK for this (but see my comment in the commit description)

> +       HID_TRANSPORT_ERROR_TYPE_HEADER_DATA,
> +       HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA,
> +       HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE,

Those look like SPI specifics

> +       HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE,

Seems like this would be better handled as a return code than an async
callback (and it should already be the case because
hid_ll_raw_request() is synchronous and can fail if the HW complains).

> +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE,
> +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE

Again, what am I supposed to do with those 2 if they fail, besides
emitting a dev_err(), which the low level transport driver can do?


Cheers,
Benjamin

> +};
> +
>  /**
>   * 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);
> --
> 2.25.1
>

RE: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver

[Dmitry Antipov]

> -----Original Message-----
> From: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> Sent: Monday, January 3, 2022 7:27 AM
> To: Dmitry Antipov <daantipov@gmail.com>
> Cc: Jiri Kosina <jikos@kernel.org>; open list:HID CORE LAYER <linux-
> input@vger.kernel.org>; Felipe Balbi <balbi@kernel.org>; Dmitry Antipov
> <dmanti@microsoft.com>
> Subject: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error() field to
> struct hid_driver
> 
> On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com>
> wrote:
> >
> > This new API allows a transport driver to notify the HID device driver
> > about a transport layer error.
> 
> I do not see entirely the purpose of this new callback:
> 
> - when we receive the device initiated reset, this is a specific device event, so it
> would make sense...
> - but for things like HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER, I
> would expect the caller to return that error code instead of having an async
> function called.
> 
> I think it might be simpler to add a more specific
> .device_initiated_reset() callback instead of trying to be generic.
> 

The intention of this new callback is to notify the device driver of a
transport-layer error for at least two reasons:
1. Delegating the decision making. For certain types of errors the spec
states that the host _may_ reset the device. Right now there are not
many devices that support HID over SPI, but I wanted to allow the
flexibility for each vendor to decide what cases to error-handle.
2. Telemetry instrumentation to gather statistics on various error
conditions hit in spi-hid. The way we implement this is by publishing
sysfs attributes with error counters from the device driver and epoll
on these attributes from userspace. Here is a snippet from a yet-to-be-
sent patch to hid-microsoft.c:

static void ms_on_transport_error(struct hid_device *hdev,
					int err_type,
					int err_code,
					bool handled)
{
	struct ms_data *ms = hid_get_drvdata(hdev);

	if (ms->quirks & MS_TRANSPORT_ERROR_HANDLING) {

		switch (err_type) {
			case HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_START:
			case HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_BODY:
			case HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_HEADER:
			case HID_TRANSPORT_ERROR_TYPE_HEADER_DATA:
			case HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER:
				ms->bus_error_count++;
				ms->bus_last_error = err_code;
				break;
			case HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET:
				ms->dir_count++;
				break;
			case HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA:
			case HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE:
			case HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE:
				if (!handled && (hdev->ll_driver->reset != 0))
					hdev->ll_driver->reset(hdev);
				break;
			case HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE:
			case HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE:
				ms->regulator_error_count++;
				ms->regulator_last_error = err_code;
				break;
		}
	}
}

Please let me know what you think. Would it be ok to make a decision to
error-handle (reset the device) at a transport layer certain cases that
are not required by the spec?

If you have a suggestion on how to pipe telemetry counters to userspace
without this generic callback I can try it out as well.

> >
> > Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> > ---
> >  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,
> 
> Those 3 enums above are completely SPI specifics, but they are declared in the
> generic hid.h header.
> Also, if I am a driver, what am I supposed to do when I receive such an error?
> Up till now, the most we did was to raise a warning to the user, and paper over
> it. I am open to some smarter behavior, but I do not see what a mouse driver is
> supposed to do with that kind of error.
> 
> > +       HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,
> 
> Seems like this would better handled as a return code than an async callback
> 
> > +       HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET,
> 
> OK for this (but see my comment in the commit description)
> 
> > +       HID_TRANSPORT_ERROR_TYPE_HEADER_DATA,
> > +       HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA,
> > +       HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE,
> 
> Those look like SPI specifics
> 
> > +       HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE,
> 
> Seems like this would be better handled as a return code than an async callback
> (and it should already be the case because
> hid_ll_raw_request() is synchronous and can fail if the HW complains).
> 
> > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE,
> > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE
> 
> Again, what am I supposed to do with those 2 if they fail, besides emitting a
> dev_err(), which the low level transport driver can do?
> 
> 
> Cheers,
> Benjamin
> 
> > +};
> > +
> >  /**
> >   * 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);
> > --
> > 2.25.1
> >

Re: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver

[Benjamin Tissoires]

On Tue, Jan 4, 2022 at 3:08 AM Dmitry Antipov <dmanti@microsoft.com> wrote:
>
> > -----Original Message-----
> > From: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> > Sent: Monday, January 3, 2022 7:27 AM
> > To: Dmitry Antipov <daantipov@gmail.com>
> > Cc: Jiri Kosina <jikos@kernel.org>; open list:HID CORE LAYER <linux-
> > input@vger.kernel.org>; Felipe Balbi <balbi@kernel.org>; Dmitry Antipov
> > <dmanti@microsoft.com>
> > Subject: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error() field to
> > struct hid_driver
> >
> > On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com>
> > wrote:
> > >
> > > This new API allows a transport driver to notify the HID device driver
> > > about a transport layer error.
> >
> > I do not see entirely the purpose of this new callback:
> >
> > - when we receive the device initiated reset, this is a specific device event, so it
> > would make sense...
> > - but for things like HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER, I
> > would expect the caller to return that error code instead of having an async
> > function called.
> >
> > I think it might be simpler to add a more specific
> > .device_initiated_reset() callback instead of trying to be generic.
> >
>
> The intention of this new callback is to notify the device driver of a
> transport-layer error for at least two reasons:
> 1. Delegating the decision making. For certain types of errors the spec
> states that the host _may_ reset the device. Right now there are not
> many devices that support HID over SPI, but I wanted to allow the
> flexibility for each vendor to decide what cases to error-handle.

Looking at section 9 (Error handling) of the HID SPI protocol spec, it
seems that the only time the host may (or not) decide to reset the
device is when receiving a timeout error.
And looking at the phrasing there, I think we ought to simply reset
the device anyway.

So now that I have the spec under my eyes, I would think that for this
part, the host is expected to reset the device, which in turn makes
this a spi-hid responsibility.

So I would suggest adding a callback notifying that the device has
been reset, and with a flag telling whether it's host or device
initiated.
Then in hid-microsoft, hid-multitouch we can deal with that situation.

Putting this at the transport layer allows for a common behavior which
won't depend on the leaf HID driver in use.

> 2. Telemetry instrumentation to gather statistics on various error
> conditions hit in spi-hid. The way we implement this is by publishing
> sysfs attributes with error counters from the device driver and epoll
> on these attributes from userspace. Here is a snippet from a yet-to-be-
> sent patch to hid-microsoft.c:

Oh, that's interesting. How about we put those stats in
api-hid-core.c, so that anybody can benefit from it?
Those are per-device anyway so that might be a useful way to debug
issues when there are weird behaviors.

>
> static void ms_on_transport_error(struct hid_device *hdev,
>                                         int err_type,
>                                         int err_code,
>                                         bool handled)
> {
>         struct ms_data *ms = hid_get_drvdata(hdev);
>
>         if (ms->quirks & MS_TRANSPORT_ERROR_HANDLING) {
>
>                 switch (err_type) {
>                         case HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_START:
>                         case HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_BODY:
>                         case HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_HEADER:
>                         case HID_TRANSPORT_ERROR_TYPE_HEADER_DATA:
>                         case HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER:
>                                 ms->bus_error_count++;
>                                 ms->bus_last_error = err_code;
>                                 break;
>                         case HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET:
>                                 ms->dir_count++;
>                                 break;
>                         case HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA:
>                         case HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE:
>                         case HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE:
>                                 if (!handled && (hdev->ll_driver->reset != 0))
>                                         hdev->ll_driver->reset(hdev);
>                                 break;
>                         case HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE:
>                         case HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE:
>                                 ms->regulator_error_count++;
>                                 ms->regulator_last_error = err_code;
>                                 break;
>                 }
>         }
> }
>
> Please let me know what you think. Would it be ok to make a decision to
> error-handle (reset the device) at a transport layer certain cases that
> are not required by the spec?

I would suggest we stay as close as possible to the spec. When the
spec says we need to reset, we do it, and notify the driver.
TBH, the only thing that works in the long run is to map the
implementation from Windows, when this gets more widespread.
And we can always quirk the devices that need a special error handling
or revisit at that particular time when we get the device in question.


>
> If you have a suggestion on how to pipe telemetry counters to userspace
> without this generic callback I can try it out as well.

So as I mentioned we should probably set those in spi-hid. The other
and more modern approach is to use BPF, but that would be only when
the program is loaded. So I would keep the raw values in spi-hid,
export them through sysfs, and possibly allow for some tracing through
BPF if we want to get something more dynamic (like real time reading
of values).

Cheers,
Benjamin

>
> > >
> > > Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> > > ---
> > >  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,
> >
> > Those 3 enums above are completely SPI specifics, but they are declared in the
> > generic hid.h header.
> > Also, if I am a driver, what am I supposed to do when I receive such an error?
> > Up till now, the most we did was to raise a warning to the user, and paper over
> > it. I am open to some smarter behavior, but I do not see what a mouse driver is
> > supposed to do with that kind of error.
> >
> > > +       HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,
> >
> > Seems like this would better handled as a return code than an async callback
> >
> > > +       HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET,
> >
> > OK for this (but see my comment in the commit description)
> >
> > > +       HID_TRANSPORT_ERROR_TYPE_HEADER_DATA,
> > > +       HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA,
> > > +       HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE,
> >
> > Those look like SPI specifics
> >
> > > +       HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE,
> >
> > Seems like this would be better handled as a return code than an async callback
> > (and it should already be the case because
> > hid_ll_raw_request() is synchronous and can fail if the HW complains).
> >
> > > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE,
> > > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE
> >
> > Again, what am I supposed to do with those 2 if they fail, besides emitting a
> > dev_err(), which the low level transport driver can do?
> >
> >
> > Cheers,
> > Benjamin
> >
> > > +};
> > > +
> > >  /**
> > >   * 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);
> > > --
> > > 2.25.1
> > >
>

RE: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver

[Dmitry Antipov]

On Tue, Jan 4, 2022 at 7:52 AM Benjamin Tissoires
<benjamin.tissoires@redhat.com> wrote:
> 
> On Tue, Jan 4, 2022 at 3:08 AM Dmitry Antipov <dmanti@microsoft.com>
> wrote:
> >
> > > -----Original Message-----
> > > From: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> > > Sent: Monday, January 3, 2022 7:27 AM
> > > To: Dmitry Antipov <daantipov@gmail.com>
> > > Cc: Jiri Kosina <jikos@kernel.org>; open list:HID CORE LAYER <linux-
> > > input@vger.kernel.org>; Felipe Balbi <balbi@kernel.org>; Dmitry
> > > Antipov <dmanti@microsoft.com>
> > > Subject: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error()
> > > field to struct hid_driver
> > >
> > > On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov
> > > <daantipov@gmail.com>
> > > wrote:
> > > >
> > > > This new API allows a transport driver to notify the HID device
> > > > driver about a transport layer error.
> > >
> > > I do not see entirely the purpose of this new callback:
> > >
> > > - when we receive the device initiated reset, this is a specific
> > > device event, so it would make sense...
> > > - but for things like
> HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,
> > > I would expect the caller to return that error code instead of
> > > having an async function called.
> > >
> > > I think it might be simpler to add a more specific
> > > .device_initiated_reset() callback instead of trying to be generic.
> > >
> >
> > The intention of this new callback is to notify the device driver of a
> > transport-layer error for at least two reasons:
> > 1. Delegating the decision making. For certain types of errors the
> > spec states that the host _may_ reset the device. Right now there are
> > not many devices that support HID over SPI, but I wanted to allow the
> > flexibility for each vendor to decide what cases to error-handle.
> 
> Looking at section 9 (Error handling) of the HID SPI protocol spec, it seems that
> the only time the host may (or not) decide to reset the device is when receiving
> a timeout error.
> And looking at the phrasing there, I think we ought to simply reset the device
> anyway.
> 
> So now that I have the spec under my eyes, I would think that for this part, the
> host is expected to reset the device, which in turn makes this a spi-hid
> responsibility.
> 
> So I would suggest adding a callback notifying that the device has been reset,
> and with a flag telling whether it's host or device initiated.
> Then in hid-microsoft, hid-multitouch we can deal with that situation.
> 
> Putting this at the transport layer allows for a common behavior which won't
> depend on the leaf HID driver in use.

Please note the "ready" flag that is wired to a sysfs attribute in
spi-hid in patch 5/5. In our case the touch digitizer sends the raw
data, so we process it and convert it into input events in a userspace
service we call the touch daemon. The touch daemon detects digitizer
resets via the ready flag: any time the flag goes from "not ready" to
"ready", it is interpreted as digitizer coming out of reset and the
touch daemon then sends some system state info to the digitizer, among
other things. While the ready flag is "not ready", in our architecture,
the userspace will not send ioctl's or write into the hidraw device.

All this means that the code in hid-microsoft won't be implementing this
new notify_of_reset() callback. Since in the final submission there
won't be an implementation of this callback, is it worth adding at this
stage? Can it go in as a REVISIT or a FIXME comment until such
notification to the leaf driver is needed?

> > 2. Telemetry instrumentation to gather statistics on various error
> > conditions hit in spi-hid. The way we implement this is by publishing
> > sysfs attributes with error counters from the device driver and epoll
> > on these attributes from userspace. Here is a snippet from a
> > yet-to-be- sent patch to hid-microsoft.c:
> 
> Oh, that's interesting. How about we put those stats in api-hid-core.c, so that
> anybody can benefit from it?
> Those are per-device anyway so that might be a useful way to debug issues
> when there are weird behaviors.

I haven't found an api-hid-core.c. Are you suggesting I create a new
file at drivers/hid that would extend hid-core.c? If yes, can you please
tell what you expect to be in the HID core vs the transport driver?

> >
> > static void ms_on_transport_error(struct hid_device *hdev,
> >                                         int err_type,
> >                                         int err_code,
> >                                         bool handled) {
> >         struct ms_data *ms = hid_get_drvdata(hdev);
> >
> >         if (ms->quirks & MS_TRANSPORT_ERROR_HANDLING) {
> >
> >                 switch (err_type) {
> >                         case
> HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_START:
> >                         case
> HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_BODY:
> >                         case
> HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_HEADER:
> >                         case HID_TRANSPORT_ERROR_TYPE_HEADER_DATA:
> >                         case HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER:
> >                                 ms->bus_error_count++;
> >                                 ms->bus_last_error = err_code;
> >                                 break;
> >                         case HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET:
> >                                 ms->dir_count++;
> >                                 break;
> >                         case HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA:
> >                         case HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE:
> >                         case HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE:
> >                                 if (!handled && (hdev->ll_driver->reset != 0))
> >                                         hdev->ll_driver->reset(hdev);
> >                                 break;
> >                         case HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE:
> >                         case HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE:
> >                                 ms->regulator_error_count++;
> >                                 ms->regulator_last_error = err_code;
> >                                 break;
> >                 }
> >         }
> > }
> >
> > Please let me know what you think. Would it be ok to make a decision
> > to error-handle (reset the device) at a transport layer certain cases
> > that are not required by the spec?
> 
> I would suggest we stay as close as possible to the spec. When the spec says we
> need to reset, we do it, and notify the driver.
> TBH, the only thing that works in the long run is to map the implementation
> from Windows, when this gets more widespread.
> And we can always quirk the devices that need a special error handling or
> revisit at that particular time when we get the device in question.
> 
> 
> >
> > If you have a suggestion on how to pipe telemetry counters to
> > userspace without this generic callback I can try it out as well.
> 
> So as I mentioned we should probably set those in spi-hid. The other and more
> modern approach is to use BPF, but that would be only when the program is
> loaded. So I would keep the raw values in spi-hid, export them through sysfs,
> and possibly allow for some tracing through BPF if we want to get something
> more dynamic (like real time reading of values).

Does api-hid-core.c play a role in the suggested non-BPF, basic approach?

> 
> Cheers,
> Benjamin
> 
> >
> > > >
> > > > Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> > > > ---
> > > >  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,
> > >
> > > Those 3 enums above are completely SPI specifics, but they are
> > > declared in the generic hid.h header.
> > > Also, if I am a driver, what am I supposed to do when I receive such an
> error?
> > > Up till now, the most we did was to raise a warning to the user, and
> > > paper over it. I am open to some smarter behavior, but I do not see
> > > what a mouse driver is supposed to do with that kind of error.
> > >
> > > > +       HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,
> > >
> > > Seems like this would better handled as a return code than an async
> > > callback
> > >
> > > > +       HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET,
> > >
> > > OK for this (but see my comment in the commit description)
> > >
> > > > +       HID_TRANSPORT_ERROR_TYPE_HEADER_DATA,
> > > > +       HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA,
> > > > +       HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE,
> > >
> > > Those look like SPI specifics
> > >
> > > > +       HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE,
> > >
> > > Seems like this would be better handled as a return code than an
> > > async callback (and it should already be the case because
> > > hid_ll_raw_request() is synchronous and can fail if the HW complains).
> > >
> > > > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE,
> > > > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE
> > >
> > > Again, what am I supposed to do with those 2 if they fail, besides
> > > emitting a dev_err(), which the low level transport driver can do?
> > >
> > >
> > > Cheers,
> > > Benjamin
> > >
> > > > +};
> > > > +
> > > >  /**
> > > >   * 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);
> > > > --
> > > > 2.25.1
> > > >
> >

Re: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver

[Benjamin Tissoires]

On Sat, Jan 8, 2022 at 2:10 AM Dmitry Antipov <dmanti@microsoft.com> wrote:
>
> On Tue, Jan 4, 2022 at 7:52 AM Benjamin Tissoires
> <benjamin.tissoires@redhat.com> wrote:
> >
> > On Tue, Jan 4, 2022 at 3:08 AM Dmitry Antipov <dmanti@microsoft.com>
> > wrote:
> > >
> > > > -----Original Message-----
> > > > From: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> > > > Sent: Monday, January 3, 2022 7:27 AM
> > > > To: Dmitry Antipov <daantipov@gmail.com>
> > > > Cc: Jiri Kosina <jikos@kernel.org>; open list:HID CORE LAYER <linux-
> > > > input@vger.kernel.org>; Felipe Balbi <balbi@kernel.org>; Dmitry
> > > > Antipov <dmanti@microsoft.com>
> > > > Subject: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error()
> > > > field to struct hid_driver
> > > >
> > > > On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov
> > > > <daantipov@gmail.com>
> > > > wrote:
> > > > >
> > > > > This new API allows a transport driver to notify the HID device
> > > > > driver about a transport layer error.
> > > >
> > > > I do not see entirely the purpose of this new callback:
> > > >
> > > > - when we receive the device initiated reset, this is a specific
> > > > device event, so it would make sense...
> > > > - but for things like
> > HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,
> > > > I would expect the caller to return that error code instead of
> > > > having an async function called.
> > > >
> > > > I think it might be simpler to add a more specific
> > > > .device_initiated_reset() callback instead of trying to be generic.
> > > >
> > >
> > > The intention of this new callback is to notify the device driver of a
> > > transport-layer error for at least two reasons:
> > > 1. Delegating the decision making. For certain types of errors the
> > > spec states that the host _may_ reset the device. Right now there are
> > > not many devices that support HID over SPI, but I wanted to allow the
> > > flexibility for each vendor to decide what cases to error-handle.
> >
> > Looking at section 9 (Error handling) of the HID SPI protocol spec, it seems that
> > the only time the host may (or not) decide to reset the device is when receiving
> > a timeout error.
> > And looking at the phrasing there, I think we ought to simply reset the device
> > anyway.
> >
> > So now that I have the spec under my eyes, I would think that for this part, the
> > host is expected to reset the device, which in turn makes this a spi-hid
> > responsibility.
> >
> > So I would suggest adding a callback notifying that the device has been reset,
> > and with a flag telling whether it's host or device initiated.
> > Then in hid-microsoft, hid-multitouch we can deal with that situation.
> >
> > Putting this at the transport layer allows for a common behavior which won't
> > depend on the leaf HID driver in use.
>
> Please note the "ready" flag that is wired to a sysfs attribute in
> spi-hid in patch 5/5. In our case the touch digitizer sends the raw
> data, so we process it and convert it into input events in a userspace
> service we call the touch daemon. The touch daemon detects digitizer
> resets via the ready flag: any time the flag goes from "not ready" to
> "ready", it is interpreted as digitizer coming out of reset and the
> touch daemon then sends some system state info to the digitizer, among
> other things. While the ready flag is "not ready", in our architecture,
> the userspace will not send ioctl's or write into the hidraw device.

So that means that this device is forwarding the raw touch map?

>
> All this means that the code in hid-microsoft won't be implementing this
> new notify_of_reset() callback. Since in the final submission there
> won't be an implementation of this callback, is it worth adding at this
> stage? Can it go in as a REVISIT or a FIXME comment until such
> notification to the leaf driver is needed?

If there is no users, then it's probably best to not implement it. We
could add a comment, yes, but maybe not a FIXME, just a regular
comment.

>
> > > 2. Telemetry instrumentation to gather statistics on various error
> > > conditions hit in spi-hid. The way we implement this is by publishing
> > > sysfs attributes with error counters from the device driver and epoll
> > > on these attributes from userspace. Here is a snippet from a
> > > yet-to-be- sent patch to hid-microsoft.c:
> >
> > Oh, that's interesting. How about we put those stats in api-hid-core.c, so that
> > anybody can benefit from it?
> > Those are per-device anyway so that might be a useful way to debug issues
> > when there are weird behaviors.
>
> I haven't found an api-hid-core.c. Are you suggesting I create a new
> file at drivers/hid that would extend hid-core.c? If yes, can you please
> tell what you expect to be in the HID core vs the transport driver?

Sorry I meant i2c-hid-core.c :(

>
> > >
> > > static void ms_on_transport_error(struct hid_device *hdev,
> > >                                         int err_type,
> > >                                         int err_code,
> > >                                         bool handled) {
> > >         struct ms_data *ms = hid_get_drvdata(hdev);
> > >
> > >         if (ms->quirks & MS_TRANSPORT_ERROR_HANDLING) {
> > >
> > >                 switch (err_type) {
> > >                         case
> > HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_START:
> > >                         case
> > HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_BODY:
> > >                         case
> > HID_TRANSPORT_ERROR_TYPE_BUS_INPUT_TRANSFER_HEADER:
> > >                         case HID_TRANSPORT_ERROR_TYPE_HEADER_DATA:
> > >                         case HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER:
> > >                                 ms->bus_error_count++;
> > >                                 ms->bus_last_error = err_code;
> > >                                 break;
> > >                         case HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET:
> > >                                 ms->dir_count++;
> > >                                 break;
> > >                         case HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA:
> > >                         case HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE:
> > >                         case HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE:
> > >                                 if (!handled && (hdev->ll_driver->reset != 0))
> > >                                         hdev->ll_driver->reset(hdev);
> > >                                 break;
> > >                         case HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE:
> > >                         case HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE:
> > >                                 ms->regulator_error_count++;
> > >                                 ms->regulator_last_error = err_code;
> > >                                 break;
> > >                 }
> > >         }
> > > }
> > >
> > > Please let me know what you think. Would it be ok to make a decision
> > > to error-handle (reset the device) at a transport layer certain cases
> > > that are not required by the spec?
> >
> > I would suggest we stay as close as possible to the spec. When the spec says we
> > need to reset, we do it, and notify the driver.
> > TBH, the only thing that works in the long run is to map the implementation
> > from Windows, when this gets more widespread.
> > And we can always quirk the devices that need a special error handling or
> > revisit at that particular time when we get the device in question.
> >
> >
> > >
> > > If you have a suggestion on how to pipe telemetry counters to
> > > userspace without this generic callback I can try it out as well.
> >
> > So as I mentioned we should probably set those in spi-hid. The other and more
> > modern approach is to use BPF, but that would be only when the program is
> > loaded. So I would keep the raw values in spi-hid, export them through sysfs,
> > and possibly allow for some tracing through BPF if we want to get something
> > more dynamic (like real time reading of values).
>
> Does api-hid-core.c play a role in the suggested non-BPF, basic approach?

Again, sorry for the confusion. I think you should keep in mind that
BPF might be a solution in the long run, but right now it's not
merged, so please ignore it for the time being :)

Cheers,
Benjamin

>
> >
> > Cheers,
> > Benjamin
> >
> > >
> > > > >
> > > > > Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> > > > > ---
> > > > >  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,
> > > >
> > > > Those 3 enums above are completely SPI specifics, but they are
> > > > declared in the generic hid.h header.
> > > > Also, if I am a driver, what am I supposed to do when I receive such an
> > error?
> > > > Up till now, the most we did was to raise a warning to the user, and
> > > > paper over it. I am open to some smarter behavior, but I do not see
> > > > what a mouse driver is supposed to do with that kind of error.
> > > >
> > > > > +       HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,
> > > >
> > > > Seems like this would better handled as a return code than an async
> > > > callback
> > > >
> > > > > +       HID_TRANSPORT_ERROR_TYPE_DEVICE_INITIATED_RESET,
> > > >
> > > > OK for this (but see my comment in the commit description)
> > > >
> > > > > +       HID_TRANSPORT_ERROR_TYPE_HEADER_DATA,
> > > > > +       HID_TRANSPORT_ERROR_TYPE_INPUT_REPORT_DATA,
> > > > > +       HID_TRANSPORT_ERROR_TYPE_REPORT_TYPE,
> > > >
> > > > Those look like SPI specifics
> > > >
> > > > > +       HID_TRANSPORT_ERROR_TYPE_GET_FEATURE_RESPONSE,
> > > >
> > > > Seems like this would be better handled as a return code than an
> > > > async callback (and it should already be the case because
> > > > hid_ll_raw_request() is synchronous and can fail if the HW complains).
> > > >
> > > > > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_ENABLE,
> > > > > +       HID_TRANSPORT_ERROR_TYPE_REGULATOR_DISABLE
> > > >
> > > > Again, what am I supposed to do with those 2 if they fail, besides
> > > > emitting a dev_err(), which the low level transport driver can do?
> > > >
> > > >
> > > > Cheers,
> > > > Benjamin
> > > >
> > > > > +};
> > > > > +
> > > > >  /**
> > > > >   * 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);
> > > > > --
> > > > > 2.25.1
> > > > >
> > >
>

Re: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error() field to struct hid_driver

[Felipe Balbi]

Hi,

Benjamin Tissoires <benjamin.tissoires@redhat.com> writes:
> On Sat, Jan 8, 2022 at 2:10 AM Dmitry Antipov <dmanti@microsoft.com> wrote:
>>
>> On Tue, Jan 4, 2022 at 7:52 AM Benjamin Tissoires
>> <benjamin.tissoires@redhat.com> wrote:
>> >
>> > On Tue, Jan 4, 2022 at 3:08 AM Dmitry Antipov <dmanti@microsoft.com>
>> > wrote:
>> > >
>> > > > -----Original Message-----
>> > > > From: Benjamin Tissoires <benjamin.tissoires@redhat.com>
>> > > > Sent: Monday, January 3, 2022 7:27 AM
>> > > > To: Dmitry Antipov <daantipov@gmail.com>
>> > > > Cc: Jiri Kosina <jikos@kernel.org>; open list:HID CORE LAYER <linux-
>> > > > input@vger.kernel.org>; Felipe Balbi <balbi@kernel.org>; Dmitry
>> > > > Antipov <dmanti@microsoft.com>
>> > > > Subject: [EXTERNAL] Re: [PATCH v1 3/5] HID: add on_transport_error()
>> > > > field to struct hid_driver
>> > > >
>> > > > On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov
>> > > > <daantipov@gmail.com>
>> > > > wrote:
>> > > > >
>> > > > > This new API allows a transport driver to notify the HID device
>> > > > > driver about a transport layer error.
>> > > >
>> > > > I do not see entirely the purpose of this new callback:
>> > > >
>> > > > - when we receive the device initiated reset, this is a specific
>> > > > device event, so it would make sense...
>> > > > - but for things like
>> > HID_TRANSPORT_ERROR_TYPE_BUS_OUTPUT_TRANSFER,
>> > > > I would expect the caller to return that error code instead of
>> > > > having an async function called.
>> > > >
>> > > > I think it might be simpler to add a more specific
>> > > > .device_initiated_reset() callback instead of trying to be generic.
>> > > >
>> > >
>> > > The intention of this new callback is to notify the device driver of a
>> > > transport-layer error for at least two reasons:
>> > > 1. Delegating the decision making. For certain types of errors the
>> > > spec states that the host _may_ reset the device. Right now there are
>> > > not many devices that support HID over SPI, but I wanted to allow the
>> > > flexibility for each vendor to decide what cases to error-handle.
>> >
>> > Looking at section 9 (Error handling) of the HID SPI protocol spec, it seems that
>> > the only time the host may (or not) decide to reset the device is when receiving
>> > a timeout error.
>> > And looking at the phrasing there, I think we ought to simply reset the device
>> > anyway.
>> >
>> > So now that I have the spec under my eyes, I would think that for this part, the
>> > host is expected to reset the device, which in turn makes this a spi-hid
>> > responsibility.
>> >
>> > So I would suggest adding a callback notifying that the device has been reset,
>> > and with a flag telling whether it's host or device initiated.
>> > Then in hid-microsoft, hid-multitouch we can deal with that situation.
>> >
>> > Putting this at the transport layer allows for a common behavior which won't
>> > depend on the leaf HID driver in use.
>>
>> Please note the "ready" flag that is wired to a sysfs attribute in
>> spi-hid in patch 5/5. In our case the touch digitizer sends the raw
>> data, so we process it and convert it into input events in a userspace
>> service we call the touch daemon. The touch daemon detects digitizer
>> resets via the ready flag: any time the flag goes from "not ready" to
>> "ready", it is interpreted as digitizer coming out of reset and the
>> touch daemon then sends some system state info to the digitizer, among
>> other things. While the ready flag is "not ready", in our architecture,
>> the userspace will not send ioctl's or write into the hidraw device.
>
> So that means that this device is forwarding the raw touch map?

yes it is. Raw touch map for fingers, some other not-truly-raw reports
for pen, and some vendor specific messages (mostly tuning-related and
some telemetry/debug data).

>> All this means that the code in hid-microsoft won't be implementing this
>> new notify_of_reset() callback. Since in the final submission there
>> won't be an implementation of this callback, is it worth adding at this
>> stage? Can it go in as a REVISIT or a FIXME comment until such
>> notification to the leaf driver is needed?
>
> If there is no users, then it's probably best to not implement it. We
> could add a comment, yes, but maybe not a FIXME, just a regular
> comment.

+1

[snip]

-- 
balbi

[PATCH v1 4/5] HID: add reset() field to struct hid_ll_driver

[Dmitry Antipov]

This new API allows a device driver to reset the device.

Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
---
 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;
-- 
2.25.1

Re: [PATCH v1 4/5] HID: add reset() field to struct hid_ll_driver

[Benjamin Tissoires]

On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com> wrote:
>
> This new API allows a device driver to reset the device.
>
> Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> ---
>  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

I'm OK with this, but we probably expand it a little bit more (and in
the commit description too). What are we supposed to reset here? Just
assert the reset line or do a full probe of the device with re-asking
for the device descriptor, then the report descriptor?

If you can, it would be very nice (but not mandatory) to implement the
expected reset callback in i2c-hid or usbhid, so we get an idea on
what need to be done in that case. (i2c-hid would probably be closer
to spi-hid).

Cheers,
Benjamin

>   */
>  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;
> --
> 2.25.1
>

[PATCH v1 5/5] HID: add spi-hid, transport driver for HID over SPI bus

[Dmitry Antipov]

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 <dmanti@microsoft.com>
---
 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 <benjamin.tissoires@gmail.com>
+ *  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 <vojtech@suse.cz>
+ *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> 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 <linux/crc32.h>
+#include <linux/delay.h>
+#include <linux/device.h>
+#include <linux/dma-mapping.h>
+#include <linux/err.h>
+#include <linux/gpio/consumer.h>
+#include <linux/hid.h>
+#include <linux/input.h>
+#include <linux/interrupt.h>
+#include <linux/irq.h>
+#include <linux/jiffies.h>
+#include <linux/kernel.h>
+#include <linux/list.h>
+#include <linux/module.h>
+#include <linux/mutex.h>
+#include <linux/of.h>
+#include <linux/regulator/consumer.h>
+#include <linux/slab.h>
+#include <linux/spi/spi.h>
+#include <linux/string.h>
+#include <linux/wait.h>
+#include <linux/workqueue.h>
+
+#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 <dmanti@microsoft.com>");
+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 <linux/completion.h>
+#include <linux/kernel.h>
+#include <linux/spi/spi.h>
+#include <linux/spinlock.h>
+#include <linux/types.h>
+
+/* 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 <linux/types.h>
+#include <linux/tracepoint.h>
+#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 <trace/define_trace.h>
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 <felipe.balbi@microsoft.com>
+ */
+
+#define CREATE_TRACE_POINTS
+#include "spi-hid_trace.h"
-- 
2.25.1

Re: [PATCH v1 5/5] HID: add spi-hid, transport driver for HID over SPI bus

[Benjamin Tissoires]

Hi Dmitry,

I probably will not give you a fully detailed review, but here are
some first points.

But before that, you probably want to also CC some of the SPI folks
that are used to review SPI drivers (Mark and the spi list)

On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com> wrote:
>
> 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.

As mentioned in my cover letter reply, please add a link to the
documentation (or at least a somewhat stable link on the msdn website)
we can quickly refer to.

>
> Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> ---
>  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

This first implementation relies on OF too.

> +       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

spi-hid-core.c :)

> + *
> + * Copyright (c) 2021 Microsoft Corporation
> + *
> + * This code is partly based on "HID over I2C protocol implementation:
> + *
> + *  Copyright (c) 2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
> + *  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 <vojtech@suse.cz>
> + *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> 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.

I think you can drop that last paragraph given that you gave the SPDX
line at the beginning of the file.

> + */
> +
> +#include <linux/crc32.h>
> +#include <linux/delay.h>
> +#include <linux/device.h>
> +#include <linux/dma-mapping.h>
> +#include <linux/err.h>
> +#include <linux/gpio/consumer.h>
> +#include <linux/hid.h>
> +#include <linux/input.h>
> +#include <linux/interrupt.h>
> +#include <linux/irq.h>
> +#include <linux/jiffies.h>
> +#include <linux/kernel.h>
> +#include <linux/list.h>
> +#include <linux/module.h>
> +#include <linux/mutex.h>
> +#include <linux/of.h>
> +#include <linux/regulator/consumer.h>
> +#include <linux/slab.h>
> +#include <linux/spi/spi.h>
> +#include <linux/string.h>
> +#include <linux/wait.h>
> +#include <linux/workqueue.h>
> +
> +#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.
> +        */

Apparently I messed up that one pretty badly: both documentation and
implementation in i2c-hid are from me and I ignored it blatantly in
i2c-hid :(
Maybe updating the documentation is enough by saying that this call
might be asynchronous so do not expect an immediate answer there.

> +       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);

As mentioned in 3/5, why the need to have an async notification of
this error when your return code already carries that information?

> +       }
> +
> +       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 */

Should be easy enough to fix in the final submission by following the
same than i2c-hid -> `post-power-on-delay-ms` as in
Documentation/devicetree/bindings/input/hid-over-i2c.txt

> +       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 *

Hmm, this feels wrong to have that many sleeps (I assume you need to
call spi_hid_power_up().

> +       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");

This looks like a debug message that should be removed (FWIW, ftrace
should give you the same feedback).

> +
> +       if (shid->attempts++ >= SPI_HID_MAX_RESET_ATTEMPTS) {
> +               dev_err(dev, "unresponsive device, aborting.\n");

Just wondering if there is no spi_err() and other definitions

> +               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 */

Maybe we can have a common default value and let some hardware
specifics overwrite it (like we now do in i2c-hid with
i2c-hid-of-goodix.c for instance).

> +       msleep(100);
> +
> +       shid->power_state = SPI_HID_POWER_MODE_ON;
> +
> +       gpiod_set_value(shid->reset_gpio, 0);

Shouldn't this set_value() be done in a helper that would also be
called in the .reset() callback?

> +}
> +
> +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);
> +       }
> +}

This function (or the equivalent with just the
device_initiated_reset() should likely be implemented in hid-core.c,
and have a definition in the generic hid.h header. All drivers that
make use of it will need to use it.

> +
> +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;

I really like the trace approach you are taking, why not add traces here?

> +
> +       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");

Please drop this one and use ftrace insteace (and/or tracepoints).

> +
> +       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");

Please drop.

> +
> +       trace_spi_hid_input_report_handler(shid);
> +
> +       if (!shid->ready) {
> +               dev_err(dev, "discarding input report, not ready!\n");

All those dev_err seem a little bit rude to the end user.

> +               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));

This should at most be dev_info(), not dev_err. dev_dbg seems better even.

> +}
> +
> +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");
Please drop

> +
> +       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));

Seems like a debug message that needs to be dropped or at least used in dev_dbg

> +}
> +
> +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.

Shouldn't you check for the CRC before submitting to hid_parse_report then?

> +        */
> +       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" },

I don't think there is a matching OF Documentation attached to this
patch series. Please add one in a separate patch and CC the proper
maintainers and list.

> +       {},
> +};
> +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);

Please look at the latest version of i2c-hid in Linus tree. We went
through a separation of the core of i2c-hid (the part the spec is
about), and the ACPI/OF bindings. It would be nice if we could have
that from day one on spi-hid too.
This allows some advantages:
- we completely separate the ACPI calls from the OF calls, making the
drivers easier to read
- i2c-hid-of.c can be in charge of the various regulators and the ACPI
version can just ignores all of that
- we can overload i2c-hid-of.c with some device specifics if we have
some device that need special parameters (like extra sleep times or
specific reset lines).

Note that I do not request you to work on the ACPI part, but just to
have a split in OF/core so we can later on easily add ACPI.

> +       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),

We probbaly need:
 .probe_type = PROBE_PREFER_ASYNCHRONOUS,

and some .pm functions

> +       },
> +       .probe          = spi_hid_probe,
> +       .remove         = spi_hid_remove,

i2c-hid also defines a .shutdown callback. Maybe we need one too?

> +       .id_table       = spi_hid_id_table,
> +};
> +
> +module_spi_driver(spi_hid_driver);
> +
> +MODULE_DESCRIPTION("HID over SPI transport driver");
> +MODULE_AUTHOR("Dmitry Antipov <dmanti@microsoft.com>");
> +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 <linux/completion.h>
> +#include <linux/kernel.h>
> +#include <linux/spi/spi.h>
> +#include <linux/spinlock.h>
> +#include <linux/types.h>
> +
> +/* 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;
> +};

As a general rule of thumb, we don't split those definitions out of
the .c file, if they are not used outside of it.

OTOH, you will need a spi-hid.h file for the OF/ACPI split so meh...

> +
> +#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.

I think you can drop that based on the SPDX header


Besides that. I assume that those trace points are used with ftrace?
If so, that's a very nice addition :)

> + */
> +
> +#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 <linux/types.h>
> +#include <linux/tracepoint.h>
> +#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 <trace/define_trace.h>
> 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 <felipe.balbi@microsoft.com>
> + */
> +
> +#define CREATE_TRACE_POINTS
> +#include "spi-hid_trace.h"
> --
> 2.25.1
>

Cheers,
Benjamin

RE: [EXTERNAL] Re: [PATCH v1 5/5] HID: add spi-hid, transport driver for HID over SPI bus

[Dmitry Antipov]

Hello Benjamin,

I'm sending this response before submitting the v3 series of patches.
Below I'll respond to your feedback one at a time describing what has
been addressed in v3 and what hasn't been, and why.

> On mon, Jan 3, 2022 at 9:26 AM Benjamin Tissoires
<benjamin.tissoires@redhat.com> wrote:
> 
> Hi Dmitry,
> 
> I probably will not give you a fully detailed review, but here are
> some first points.
> 
> But before that, you probably want to also CC some of the SPI folks
> that are used to review SPI drivers (Mark and the spi list)
> 
> On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com>
> wrote:
> >
> > 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.
> 
> As mentioned in my cover letter reply, please add a link to the
> documentation (or at least a somewhat stable link on the msdn website)
> we can quickly refer to.

I believe MSDN website is no longer supported, but I found a stable link
to the download page for the spec. It will be listed in the cover
letter, the patch with spi-hid, and in the DT bindings documentation.

> 
> >
> > Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
> > ---
> >  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
> 
> This first implementation relies on OF too.

Will be fixed in v3.

> > +       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
> 
> spi-hid-core.c :)

Will be fixed in v3. Thank you.
 
> > + *
> > + * Copyright (c) 2021 Microsoft Corporation
> > + *
> > + * This code is partly based on "HID over I2C protocol implementation:
> > + *
> > + *  Copyright (c) 2012 Benjamin Tissoires <benjamin.tissoires@gmail.com>
> > + *  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 <vojtech@suse.cz>
> > + *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> 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.
> 
> I think you can drop that last paragraph given that you gave the SPDX
> line at the beginning of the file.
> 

Addressed in V3. Thank you.

> > + */
> > +
> > +#include <linux/crc32.h>
> > +#include <linux/delay.h>
> > +#include <linux/device.h>
> > +#include <linux/dma-mapping.h>
> > +#include <linux/err.h>
> > +#include <linux/gpio/consumer.h>
> > +#include <linux/hid.h>
> > +#include <linux/input.h>
> > +#include <linux/interrupt.h>
> > +#include <linux/irq.h>
> > +#include <linux/jiffies.h>
> > +#include <linux/kernel.h>
> > +#include <linux/list.h>
> > +#include <linux/module.h>
> > +#include <linux/mutex.h>
> > +#include <linux/of.h>
> > +#include <linux/regulator/consumer.h>
> > +#include <linux/slab.h>
> > +#include <linux/spi/spi.h>
> > +#include <linux/string.h>
> > +#include <linux/wait.h>
> > +#include <linux/workqueue.h>
> > +
> > +#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.
> > +        */
> 
> Apparently I messed up that one pretty badly: both documentation and
> implementation in i2c-hid are from me and I ignored it blatantly in
> i2c-hid :(
> Maybe updating the documentation is enough by saying that this call
> might be asynchronous so do not expect an immediate answer there.

I have added a separate patch changing this bit of documentation in v3.

> 
> > +       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);
> 
> As mentioned in 3/5, why the need to have an async notification of
> this error when your return code already carries that information?

This was done to send telemetry out of the leaf driver. Telemetry moved
back into spi-hid in v3, so this code will be gone.

> > +       }
> > +
> > +       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 */
> 
> Should be easy enough to fix in the final submission by following the
> same than i2c-hid -> `post-power-on-delay-ms` as in
> Documentation/devicetree/bindings/input/hid-over-i2c.txt

Addressed in v3.

> 
> > +       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 *
> 
> Hmm, this feels wrong to have that many sleeps (I assume you need to
> call spi_hid_power_up().

After double checking with our HW team I removed this sleep in v3.

> 
> > +       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");
> 
> This looks like a debug message that should be removed (FWIW, ftrace
> should give you the same feedback).

This and many other unnecessary debug prints have been removed in v3.

> > +
> > +       if (shid->attempts++ >= SPI_HID_MAX_RESET_ATTEMPTS) {
> > +               dev_err(dev, "unresponsive device, aborting.\n");
> 
> Just wondering if there is no spi_err() and other definitions

I grepped around, but didn't see spi_err() anywhere.

> 
> > +               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 */
> 
> Maybe we can have a common default value and let some hardware
> specifics overwrite it (like we now do in i2c-hid with
> i2c-hid-of-goodix.c for instance).

In v3 I created a minimal_reset_delay_ms that takes care of this.

> 
> > +       msleep(100);
> > +
> > +       shid->power_state = SPI_HID_POWER_MODE_ON;
> > +
> > +       gpiod_set_value(shid->reset_gpio, 0);
> 
> Shouldn't this set_value() be done in a helper that would also be
> called in the .reset() callback?

In v3 the .reset() callback is gone, and this set_value() is moved to
the spi-hid-of.c

> > +}
> > +
> > +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);
> > +       }
> > +}
> 
> This function (or the equivalent with just the
> device_initiated_reset() should likely be implemented in hid-core.c,
> and have a definition in the generic hid.h header. All drivers that
> make use of it will need to use it.
> 

Since based on the discussion in 3/5 patch I moved all error-handling
into transport, as well as telemetry, this callback is no longer needed
and is removed in v3.

> > +
> > +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;
> 
> I really like the trace approach you are taking, why not add traces here?

We have traces in spi_hid_output() called below.

> 
> > +
> > +       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");
> 
> Please drop this one and use ftrace insteace (and/or tracepoints).
> 
> > +
> > +       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");
> 
> Please drop.
> 
> > +
> > +       trace_spi_hid_input_report_handler(shid);
> > +
> > +       if (!shid->ready) {
> > +               dev_err(dev, "discarding input report, not ready!\n");
> 
> All those dev_err seem a little bit rude to the end user.
> 
> > +               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));
> 
> This should at most be dev_info(), not dev_err. dev_dbg seems better even.
> 
> > +}
> > +
> > +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");
> Please drop
> 
> > +
> > +       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));
> 
> Seems like a debug message that needs to be dropped or at least used in
> dev_dbg
> 
> > +}
> > +
> > +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.
> 
> Shouldn't you check for the CRC before submitting to hid_parse_report then?

I recently tested a touch digitizer firmware with a bungled report
descriptor. Nothing in the HID stack returned an error, but the hidraw
device was not installed. Short of traversing the /dev/ location I am
not sure how to confirm that hid_add_device() did what we expect it to.
		
We keep the device (/dev/hidraw# in our case) installed during suspend
sessions (saves time and kernel memory on resumes from sleep), but if
the report descriptor changes, its CRC will not match the cached one (we
check in spi_hid_refresh_device_work) and we will reinstall the device,
so we won't be surprised if the device starts sending unexpected
reports.

> 
> > +        */
> > +       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" },
> 
> I don't think there is a matching OF Documentation attached to this
> patch series. Please add one in a separate patch and CC the proper
> maintainers and list.

Will be done in v3.

> 
> > +       {},
> > +};
> > +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);
> 
> Please look at the latest version of i2c-hid in Linus tree. We went
> through a separation of the core of i2c-hid (the part the spec is
> about), and the ACPI/OF bindings. It would be nice if we could have
> that from day one on spi-hid too.
> This allows some advantages:
> - we completely separate the ACPI calls from the OF calls, making the
> drivers easier to read
> - i2c-hid-of.c can be in charge of the various regulators and the ACPI
> version can just ignores all of that
> - we can overload i2c-hid-of.c with some device specifics if we have
> some device that need special parameters (like extra sleep times or
> specific reset lines).
> 
> Note that I do not request you to work on the ACPI part, but just to
> have a split in OF/core so we can later on easily add ACPI.

Will be done in v3.

> 
> > +       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),
> 
> We probbaly need:
>  .probe_type = PROBE_PREFER_ASYNCHRONOUS,
> 
> and some .pm functions

I added the probe_type change in v3, but not the .pm functions. They
will have to come in v4 or later. Please note that in our implementation
in the shipped device we didn't have these .pm functions. The transport
is interrupt-driven and the SPI driver below has its own power
management.

> 
> > +       },
> > +       .probe          = spi_hid_probe,
> > +       .remove         = spi_hid_remove,
> 
> i2c-hid also defines a .shutdown callback. Maybe we need one too?

I did not add the .shutdown() callback in v3. It will have to come in v4
or later.

> 
> > +       .id_table       = spi_hid_id_table,
> > +};
> > +
> > +module_spi_driver(spi_hid_driver);
> > +
> > +MODULE_DESCRIPTION("HID over SPI transport driver");
> > +MODULE_AUTHOR("Dmitry Antipov <dmanti@microsoft.com>");
> > +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 <linux/completion.h>
> > +#include <linux/kernel.h>
> > +#include <linux/spi/spi.h>
> > +#include <linux/spinlock.h>
> > +#include <linux/types.h>
> > +
> > +/* 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;
> > +};
> 
> As a general rule of thumb, we don't split those definitions out of
> the .c file, if they are not used outside of it.
> 
> OTOH, you will need a spi-hid.h file for the OF/ACPI split so meh...
> 
> > +
> > +#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.
> 
> I think you can drop that based on the SPDX header
> 
> 
> Besides that. I assume that those trace points are used with ftrace?
> If so, that's a very nice addition :)

Indeed, with ftrace. Thank you :)

> 
> > + */
> > +
> > +#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 <linux/types.h>
> > +#include <linux/tracepoint.h>
> > +#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 <trace/define_trace.h>
> > 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 <felipe.balbi@microsoft.com>
> > + */
> > +
> > +#define CREATE_TRACE_POINTS
> > +#include "spi-hid_trace.h"
> > --
> > 2.25.1
> >
> 
> Cheers,
> Benjamin

Re: [EXTERNAL] Re: [PATCH v1 5/5] HID: add spi-hid, transport driver for HID over SPI bus

[Felipe Balbi]

Hi,

Dmitry Antipov <dmanti@microsoft.com> writes:
>> > +       /*
>> > +        * 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.
>> 
>> Shouldn't you check for the CRC before submitting to hid_parse_report then?
>
> I recently tested a touch digitizer firmware with a bungled report
> descriptor. Nothing in the HID stack returned an error, but the hidraw
> device was not installed. Short of traversing the /dev/ location I am
> not sure how to confirm that hid_add_device() did what we expect it to.
> 		
> We keep the device (/dev/hidraw# in our case) installed during suspend
> sessions (saves time and kernel memory on resumes from sleep), but if
> the report descriptor changes, its CRC will not match the cached one (we
> check in spi_hid_refresh_device_work) and we will reinstall the device,
> so we won't be surprised if the device starts sending unexpected
> reports.

note that the same behavior can potentially trigger after a FW upgrade
of the digitizer if either device or report descriptors change. That's
the only reason why the CRC exists today, so the driver can detect that
the other side "is another device".

-- 
balbi

Re: [PATCH v1 0/5] Add spi-hid, transport for HID over SPI bus

[Benjamin Tissoires]

Hi Dmitry,

Thanks a lot for the submission. It is in a much better form than the
previous version.

I do have a few general comments and then will comment on each commit.

On Thu, Dec 30, 2021 at 12:11 AM Dmitry Antipov <daantipov@gmail.com> wrote:
>
> Surface Duo devices use a touch digitizer that communicates to the main
> SoC via SPI and presents itself as a HID device. This patch's goal is to
> add the spi-hid transport driver to drivers/hid. The driver follows the
> publically available HID Over SPI Protocol Specification version 1.0.

I managed to find the spec on the website, but ideally could you add a
link here and in your 5/5 patch so we keep a trace of it?

>
> In the initial commits there are some HID core changes to support a SPI
> device, followed by extensions to hid_driver and hid_ll_driver structs
> to allow for some error-handling logic delegation from the transport
> layer to the device driver, and finally the SPI HID transport driver.

The 2 other comments I have are:

- your patches need to have the same Signed-off-by: line than the
From: line. If you can't use your email from your SoB line, just add
in the commit description the from line.
For example, the formatted patch would be:
---
From: Submitter <submitter@gmail.com>
Subject: This is patch one

From: Author Name <author@company.com>

This is the description

Signed-off-by: Author Name <author@company.com>
---

This should allow checkpatch to not complain about it too (tip: use
(and fix) `./scripts/checkpatch.pl -g ...HEAD~5` on your tree before
submitting)

- Please use a version numbering when submitting patches (well, at
least use v2 here).
We already saw a first submission, and adding a v2 and the changes is
nicer for the reviewers to know what we can assume that have been
fixed.

More onto each patch.

Cheers,
Benjamin

>
> Dmitry Antipov (5):
>   HID: Add BUS_SPI support when printing out device info in
>     hid_connect()
>   HID: define HID_SPI_DEVICE macro in hid.h
>   HID: add on_transport_error() field to struct hid_driver
>   HID: add reset() field to struct hid_ll_driver
>   HID: add spi-hid, transport driver for HID over SPI bus
>
>  arch/arm64/configs/defconfig        |    1 +
>  drivers/hid/Kconfig                 |    2 +
>  drivers/hid/Makefile                |    1 +
>  drivers/hid/hid-core.c              |    3 +
>  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 +
>  include/linux/hid.h                 |   24 +
>  11 files changed, 1964 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
>
> --
> 2.25.1
>