Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: HID: hid-transport editing & corrections

Do basic editing & correction to hid-transport.rst:
- s/responsible of/responsible for/
- fix grammar & punctuation

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: linux-input@vger.kernel.org
Cc: David Herrmann <dh.herrmann@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Jonathan Cameron <jic23@kernel.org>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

authored by

Randy Dunlap and committed by
Jiri Kosina
a14e9d72 ce6bf2d9

+6 -6
+6 -6
Documentation/hid/hid-transport.rst
··· 12 12 13 13 The HID subsystem is designed as a bus. Any I/O subsystem may provide HID 14 14 devices and register them with the HID bus. HID core then loads generic device 15 - drivers on top of it. The transport drivers are responsible of raw data 16 - transport and device setup/management. HID core is responsible of 15 + drivers on top of it. The transport drivers are responsible for raw data 16 + transport and device setup/management. HID core is responsible for 17 17 report-parsing, report interpretation and the user-space API. Device specifics 18 18 and quirks are handled by all layers depending on the quirk. 19 19 ··· 67 67 device. Once a device is registered with HID core, the callbacks provided via 68 68 this struct are used by HID core to communicate with the device. 69 69 70 - Transport drivers are responsible of detecting device failures and unplugging. 70 + Transport drivers are responsible for detecting device failures and unplugging. 71 71 HID core will operate a device as long as it is registered regardless of any 72 72 device failures. Once transport drivers detect unplug or failure events, they 73 73 must unregister the device from HID core and HID core will stop using the ··· 101 101 channel. Any unrequested incoming or outgoing data report must be sent on 102 102 this channel and is never acknowledged by the remote side. Devices usually 103 103 send their input events on this channel. Outgoing events are normally 104 - not send via intr, except if high throughput is required. 104 + not sent via intr, except if high throughput is required. 105 105 - Control Channel (ctrl): The ctrl channel is used for synchronous requests and 106 106 device management. Unrequested data input events must not be sent on this 107 107 channel and are normally ignored. Instead, devices only send management ··· 161 161 payload may be blocked by the underlying transport driver if the 162 162 specification does not allow them. 163 163 - SET_REPORT: A SET_REPORT request has a report ID plus data as payload. It is 164 - sent from host to device and a device must update it's current report state 164 + sent from host to device and a device must update its current report state 165 165 according to the given data. Any of the 3 report types can be used. However, 166 166 INPUT reports as payload might be blocked by the underlying transport driver 167 167 if the specification does not allow them. ··· 294 294 void (*request) (struct hid_device *hdev, struct hid_report *report, 295 295 int reqtype) 296 296 297 - Send an HID request on the ctrl channel. "report" contains the report that 297 + Send a HID request on the ctrl channel. "report" contains the report that 298 298 should be sent and "reqtype" the request type. Request-type can be 299 299 HID_REQ_SET_REPORT or HID_REQ_GET_REPORT. 300 300