Documentation: HID: hiddev editing & corrections
Do basic editing & correction to hiddev.rst: - use HID instead of hid consistently - add hyphenation of multi-word adjectives - drop a duplicate word - unhyphenate "a priori" 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: 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>
This commit is contained in:
parent
4acdc5e5ca
commit
750376f5e1
|
@ -27,7 +27,7 @@ the following::
|
||||||
--> hiddev.c ----> POWER / MONITOR CONTROL
|
--> hiddev.c ----> POWER / MONITOR CONTROL
|
||||||
|
|
||||||
In addition, other subsystems (apart from USB) can potentially feed
|
In addition, other subsystems (apart from USB) can potentially feed
|
||||||
events into the input subsystem, but these have no effect on the hid
|
events into the input subsystem, but these have no effect on the HID
|
||||||
device interface.
|
device interface.
|
||||||
|
|
||||||
Using the HID Device Interface
|
Using the HID Device Interface
|
||||||
|
@ -73,7 +73,7 @@ The hiddev API uses a read() interface, and a set of ioctl() calls.
|
||||||
HID devices exchange data with the host computer using data
|
HID devices exchange data with the host computer using data
|
||||||
bundles called "reports". Each report is divided into "fields",
|
bundles called "reports". Each report is divided into "fields",
|
||||||
each of which can have one or more "usages". In the hid-core,
|
each of which can have one or more "usages". In the hid-core,
|
||||||
each one of these usages has a single signed 32 bit value.
|
each one of these usages has a single signed 32-bit value.
|
||||||
|
|
||||||
read():
|
read():
|
||||||
-------
|
-------
|
||||||
|
@ -113,7 +113,7 @@ HIDIOCAPPLICATION
|
||||||
- (none)
|
- (none)
|
||||||
|
|
||||||
This ioctl call returns the HID application usage associated with the
|
This ioctl call returns the HID application usage associated with the
|
||||||
hid device. The third argument to ioctl() specifies which application
|
HID device. The third argument to ioctl() specifies which application
|
||||||
index to get. This is useful when the device has more than one
|
index to get. This is useful when the device has more than one
|
||||||
application collection. If the index is invalid (greater or equal to
|
application collection. If the index is invalid (greater or equal to
|
||||||
the number of application collections this device has) the ioctl
|
the number of application collections this device has) the ioctl
|
||||||
|
@ -181,7 +181,7 @@ looked up by type (input, output or feature) and id, so these fields
|
||||||
must be filled in by the user. The ID can be absolute -- the actual
|
must be filled in by the user. The ID can be absolute -- the actual
|
||||||
report id as reported by the device -- or relative --
|
report id as reported by the device -- or relative --
|
||||||
HID_REPORT_ID_FIRST for the first report, and (HID_REPORT_ID_NEXT |
|
HID_REPORT_ID_FIRST for the first report, and (HID_REPORT_ID_NEXT |
|
||||||
report_id) for the next report after report_id. Without a-priori
|
report_id) for the next report after report_id. Without a priori
|
||||||
information about report ids, the right way to use this ioctl is to
|
information about report ids, the right way to use this ioctl is to
|
||||||
use the relative IDs above to enumerate the valid IDs. The ioctl
|
use the relative IDs above to enumerate the valid IDs. The ioctl
|
||||||
returns non-zero when there is no more next ID. The real report ID is
|
returns non-zero when there is no more next ID. The real report ID is
|
||||||
|
@ -200,7 +200,7 @@ HIDIOCGUCODE
|
||||||
- struct hiddev_usage_ref (read/write)
|
- struct hiddev_usage_ref (read/write)
|
||||||
|
|
||||||
Returns the usage_code in a hiddev_usage_ref structure, given that
|
Returns the usage_code in a hiddev_usage_ref structure, given that
|
||||||
given its report type, report id, field index, and index within the
|
its report type, report id, field index, and index within the
|
||||||
field have already been filled into the structure.
|
field have already been filled into the structure.
|
||||||
|
|
||||||
HIDIOCGUSAGE
|
HIDIOCGUSAGE
|
||||||
|
|
Loading…
Reference in New Issue