All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jarrett Schultz <jaschultzms@gmail.com>
To: Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Catalin Marinas <catalin.marinas@arm.com>,
	Will Deacon <will@kernel.org>, Jiri Kosina <jikos@kernel.org>,
	Benjamin Tissoires <benjamin.tissoires@redhat.com>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Shawn Guo <shawnguo@kernel.org>,
	Geert Uytterhoeven <geert+renesas@glider.be>,
	Marcel Ziswiler <marcel.ziswiler@toradex.com>,
	Biju Das <biju.das.jz@bp.renesas.com>,
	Dmitry Baryshkov <dmitry.baryshkov@linaro.org>,
	Vinod Koul <vkoul@kernel.org>
Cc: Dmitry Antipov <dmanti@microsoft.com>,
	linux-input@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	Jarrett Schultz <jaschultz@microsoft.com>
Subject: [PATCH v5 4/6] Documentation: Correction in HID output_report callback description.
Date: Thu,  7 Jul 2022 09:59:00 -0700	[thread overview]
Message-ID: <20220707165902.3184-5-jaschultzMS@gmail.com> (raw)
In-Reply-To: <20220707165902.3184-1-jaschultzMS@gmail.com>

From: Jarrett Schultz <jaschultz@microsoft.com>

Originally output_report callback was described as must-be asynchronous,
but that is not the case in some implementations, namely i2c-hid.
Correct the documentation to say that it may be asynchronous.

Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
---
 Documentation/hid/hid-transport.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/hid/hid-transport.rst b/Documentation/hid/hid-transport.rst
index 6f1692da296c..2008cf432af1 100644
--- a/Documentation/hid/hid-transport.rst
+++ b/Documentation/hid/hid-transport.rst
@@ -327,8 +327,8 @@ The available HID callbacks are:
 
    Send raw output report via intr channel. Used by some HID device drivers
    which require high throughput for outgoing requests on the intr channel. This
-   must not cause SET_REPORT calls! This must be implemented as asynchronous
-   output report on the intr channel!
+   must not cause SET_REPORT calls! This call might be asynchronous, so the
+   caller should not expect an immediate response!
 
    ::
 
-- 
2.25.1


WARNING: multiple messages have this Message-ID (diff)
From: Jarrett Schultz <jaschultzms@gmail.com>
To: Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Catalin Marinas <catalin.marinas@arm.com>,
	Will Deacon <will@kernel.org>, Jiri Kosina <jikos@kernel.org>,
	Benjamin Tissoires <benjamin.tissoires@redhat.com>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Shawn Guo <shawnguo@kernel.org>,
	Geert Uytterhoeven <geert+renesas@glider.be>,
	Marcel Ziswiler <marcel.ziswiler@toradex.com>,
	Biju Das <biju.das.jz@bp.renesas.com>,
	Dmitry Baryshkov <dmitry.baryshkov@linaro.org>,
	Vinod Koul <vkoul@kernel.org>
Cc: Dmitry Antipov <dmanti@microsoft.com>,
	linux-input@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	Jarrett Schultz <jaschultz@microsoft.com>
Subject: [PATCH v5 4/6] Documentation: Correction in HID output_report callback description.
Date: Thu,  7 Jul 2022 09:59:00 -0700	[thread overview]
Message-ID: <20220707165902.3184-5-jaschultzMS@gmail.com> (raw)
In-Reply-To: <20220707165902.3184-1-jaschultzMS@gmail.com>

From: Jarrett Schultz <jaschultz@microsoft.com>

Originally output_report callback was described as must-be asynchronous,
but that is not the case in some implementations, namely i2c-hid.
Correct the documentation to say that it may be asynchronous.

Signed-off-by: Dmitry Antipov <dmanti@microsoft.com>
---
 Documentation/hid/hid-transport.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/hid/hid-transport.rst b/Documentation/hid/hid-transport.rst
index 6f1692da296c..2008cf432af1 100644
--- a/Documentation/hid/hid-transport.rst
+++ b/Documentation/hid/hid-transport.rst
@@ -327,8 +327,8 @@ The available HID callbacks are:
 
    Send raw output report via intr channel. Used by some HID device drivers
    which require high throughput for outgoing requests on the intr channel. This
-   must not cause SET_REPORT calls! This must be implemented as asynchronous
-   output report on the intr channel!
+   must not cause SET_REPORT calls! This call might be asynchronous, so the
+   caller should not expect an immediate response!
 
    ::
 
-- 
2.25.1


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2022-07-07 16:59 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-07 16:58 [PATCH v5 0/6] Add spi-hid, transport for HID over SPI bus Jarrett Schultz
2022-07-07 16:58 ` Jarrett Schultz
2022-07-07 16:58 ` [PATCH v5 1/6] HID: Add BUS_SPI support when printing out device info in hid_connect() Jarrett Schultz
2022-07-07 16:58   ` Jarrett Schultz
2022-07-07 16:58 ` [PATCH v5 2/6] HID: define HID_SPI_DEVICE macro in hid.h Jarrett Schultz
2022-07-07 16:58   ` Jarrett Schultz
2022-07-07 16:58 ` [PATCH v5 3/6] dt-bindings: input: Document Microsoft G6 Touch Digitizer Jarrett Schultz
2022-07-07 16:58   ` Jarrett Schultz
2022-07-11 22:43   ` Rob Herring
2022-07-11 22:43     ` Rob Herring
2022-07-07 16:59 ` Jarrett Schultz [this message]
2022-07-07 16:59   ` [PATCH v5 4/6] Documentation: Correction in HID output_report callback description Jarrett Schultz
2022-07-07 16:59 ` [PATCH v5 5/6] HID: add spi-hid, transport driver for HID over SPI bus Jarrett Schultz
2022-07-07 16:59   ` Jarrett Schultz
2022-07-07 20:51   ` Randy Dunlap
2022-07-07 20:51     ` Randy Dunlap
2022-07-12  0:54   ` kernel test robot
2022-07-12  0:54     ` kernel test robot
2022-07-07 16:59 ` [PATCH v5 6/6] Enable building drivers/hid/spi-hid as a module Jarrett Schultz
2022-07-07 16:59   ` Jarrett Schultz
2022-08-09  0:53 ` [PATCH v5 0/6] Add spi-hid, transport for HID over SPI bus Maximilian Luz
2022-08-09  0:53   ` Maximilian Luz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220707165902.3184-5-jaschultzMS@gmail.com \
    --to=jaschultzms@gmail.com \
    --cc=benjamin.tissoires@redhat.com \
    --cc=biju.das.jz@bp.renesas.com \
    --cc=bjorn.andersson@linaro.org \
    --cc=catalin.marinas@arm.com \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=dmanti@microsoft.com \
    --cc=dmitry.baryshkov@linaro.org \
    --cc=dmitry.torokhov@gmail.com \
    --cc=geert+renesas@glider.be \
    --cc=jaschultz@microsoft.com \
    --cc=jikos@kernel.org \
    --cc=krzysztof.kozlowski+dt@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=marcel.ziswiler@toradex.com \
    --cc=robh+dt@kernel.org \
    --cc=shawnguo@kernel.org \
    --cc=vkoul@kernel.org \
    --cc=will@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.