From: Randy Dunlap <email@example.com> To: firstname.lastname@example.org Cc: Randy Dunlap <email@example.com>, Jiri Kosina <firstname.lastname@example.org>, Benjamin Tissoires <email@example.com>, firstname.lastname@example.org, Jonathan Cameron <email@example.com>, Srinivas Pandruvada <firstname.lastname@example.org>, email@example.com, Jonathan Corbet <firstname.lastname@example.org>, email@example.com, David Herrmann <firstname.lastname@example.org> Subject: [PATCH 7/8] Documentation: HID: hid-transport editing & corrections Date: Thu, 3 Dec 2020 22:20:21 -0800 [thread overview] Message-ID: <email@example.com> (raw) In-Reply-To: <firstname.lastname@example.org> Do basic editing & correction to hid-transport.rst: - s/responsible of/responsible for/ - fix grammar & punctuation Signed-off-by: Randy Dunlap <email@example.com> Cc: Jiri Kosina <firstname.lastname@example.org> Cc: Benjamin Tissoires <email@example.com> Cc: firstname.lastname@example.org Cc: David Herrmann <email@example.com> Cc: Jonathan Corbet <firstname.lastname@example.org> Cc: email@example.com --- Documentation/hid/hid-transport.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) --- linux-next-20201201.orig/Documentation/hid/hid-transport.rst +++ linux-next-20201201/Documentation/hid/hid-transport.rst @@ -12,8 +12,8 @@ Bluetooth, I2C and user-space I/O driver The HID subsystem is designed as a bus. Any I/O subsystem may provide HID devices and register them with the HID bus. HID core then loads generic device -drivers on top of it. The transport drivers are responsible of raw data -transport and device setup/management. HID core is responsible of +drivers on top of it. The transport drivers are responsible for raw data +transport and device setup/management. HID core is responsible for report-parsing, report interpretation and the user-space API. Device specifics and quirks are handled by all layers depending on the quirk. @@ -67,7 +67,7 @@ Transport drivers attach a constant "str device. Once a device is registered with HID core, the callbacks provided via this struct are used by HID core to communicate with the device. -Transport drivers are responsible of detecting device failures and unplugging. +Transport drivers are responsible for detecting device failures and unplugging. HID core will operate a device as long as it is registered regardless of any device failures. Once transport drivers detect unplug or failure events, they must unregister the device from HID core and HID core will stop using the @@ -101,7 +101,7 @@ properties in common. channel. Any unrequested incoming or outgoing data report must be sent on this channel and is never acknowledged by the remote side. Devices usually send their input events on this channel. Outgoing events are normally - not send via intr, except if high throughput is required. + not sent via intr, except if high throughput is required. - Control Channel (ctrl): The ctrl channel is used for synchronous requests and device management. Unrequested data input events must not be sent on this channel and are normally ignored. Instead, devices only send management @@ -161,7 +161,7 @@ allowed on the intr channel and are the payload may be blocked by the underlying transport driver if the specification does not allow them. - SET_REPORT: A SET_REPORT request has a report ID plus data as payload. It is - sent from host to device and a device must update it's current report state + sent from host to device and a device must update its current report state according to the given data. Any of the 3 report types can be used. However, INPUT reports as payload might be blocked by the underlying transport driver if the specification does not allow them. @@ -294,7 +294,7 @@ The available HID callbacks are: void (*request) (struct hid_device *hdev, struct hid_report *report, int reqtype) - Send an HID request on the ctrl channel. "report" contains the report that + Send a HID request on the ctrl channel. "report" contains the report that should be sent and "reqtype" the request type. Request-type can be HID_REQ_SET_REPORT or HID_REQ_GET_REPORT.
next prev parent reply other threads:[~2020-12-04 6:22 UTC|newest] Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-12-04 6:20 [PATCH 0/8] Documentation: HID: edit/correct all files Randy Dunlap 2020-12-04 6:20 ` [PATCH 1/8] Documentation: HID: hid-alps editing & corrections Randy Dunlap 2020-12-04 6:20 ` [PATCH 2/8] Documentation: HID: amd-sfh-hid " Randy Dunlap 2020-12-05 17:12 ` Jonathan Cameron 2020-12-14 0:55 ` Randy Dunlap 2020-12-04 6:20 ` [PATCH 3/8] Documentation: HID: hiddev " Randy Dunlap 2020-12-05 17:17 ` Jonathan Cameron 2020-12-04 6:20 ` [PATCH 4/8] Documentation: HID: intel-ish-hid " Randy Dunlap 2020-12-05 17:24 ` Jonathan Cameron 2020-12-04 6:20 ` [PATCH 5/8] Documentation: HID: hidraw " Randy Dunlap 2020-12-04 6:20 ` [PATCH 6/8] Documentation: HID: hid-sensor " Randy Dunlap 2020-12-04 6:20 ` Randy Dunlap [this message] 2020-12-04 6:20 ` [PATCH 8/8] Documentation: HID: uhid " Randy Dunlap
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 \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --subject='Re: [PATCH 7/8] Documentation: HID: hid-transport editing & corrections' \ /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
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).