Commit cca47861 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Benjamin Tissoires

docs: hid: convert to ReST

Rename the HID documentation files to ReST, add an
index for them and adjust in order to produce a nice html
output via the Sphinx build system.

While here, fix the sysfs example from hid-sensor.txt, that
has a lot of "?" instead of the proper UTF-8 characters that
are produced by the tree command.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: default avatarBenjamin Tissoires <benjamin.tissoires@redhat.com>
Signed-off-by: default avatarBenjamin Tissoires <benjamin.tissoires@redhat.com>
parent 763cf1f2
==========================
ALPS HID Touchpad Protocol ALPS HID Touchpad Protocol
---------------------- ==========================
Introduction Introduction
------------ ------------
Currently ALPS HID driver supports U1 Touchpad device. Currently ALPS HID driver supports U1 Touchpad device.
U1 devuce basic information. U1 device basic information.
========== ======
Vender ID 0x044E Vender ID 0x044E
Product ID 0x120B Product ID 0x120B
Version ID 0x0121 Version ID 0x0121
========== ======
HID Descriptor HID Descriptor
------------ --------------
======= ==================== ===== =======================================
Byte Field Value Notes Byte Field Value Notes
======= ==================== ===== =======================================
0 wHIDDescLength 001E Length of HID Descriptor : 30 bytes 0 wHIDDescLength 001E Length of HID Descriptor : 30 bytes
2 bcdVersion 0100 Compliant with Version 1.00 2 bcdVersion 0100 Compliant with Version 1.00
4 wReportDescLength 00B2 Report Descriptor is 178 Bytes (0x00B2) 4 wReportDescLength 00B2 Report Descriptor is 178 Bytes (0x00B2)
...@@ -28,32 +35,42 @@ Byte Field Value Notes ...@@ -28,32 +35,42 @@ Byte Field Value Notes
22 wProductID 120B Product ID 0x120B 22 wProductID 120B Product ID 0x120B
24 wVersionID 0121 Version 01.21 24 wVersionID 0121 Version 01.21
26 RESERVED 0000 RESERVED 26 RESERVED 0000 RESERVED
======= ==================== ===== =======================================
Report ID Report ID
------------ ---------
ReportID-1 (Input Reports) (HIDUsage-Mouse) for TP&SP
ReportID-2 (Input Reports) (HIDUsage-keyboard) for TP ========== ================= =========================================
ReportID-3 (Input Reports) (Vendor Usage: Max 10 finger data) for TP ReportID-1 (Input Reports) (HIDUsage-Mouse) for TP&SP
ReportID-4 (Input Reports) (Vendor Usage: ON bit data) for GP ReportID-2 (Input Reports) (HIDUsage-keyboard) for TP
ReportID-5 (Feature Reports) Feature Reports ReportID-3 (Input Reports) (Vendor Usage: Max 10 finger data) for TP
ReportID-6 (Input Reports) (Vendor Usage: StickPointer data) for SP ReportID-4 (Input Reports) (Vendor Usage: ON bit data) for GP
ReportID-7 (Feature Reports) Flash update (Bootloader) ReportID-5 (Feature Reports) Feature Reports
ReportID-6 (Input Reports) (Vendor Usage: StickPointer data) for SP
ReportID-7 (Feature Reports) Flash update (Bootloader)
========== ================= =========================================
Data pattern Data pattern
------------ ------------
===== ========== ===== =================
Case1 ReportID_1 TP/SP Relative/Relative Case1 ReportID_1 TP/SP Relative/Relative
Case2 ReportID_3 TP Absolute Case2 ReportID_3 TP Absolute
ReportID_6 SP Absolute ReportID_6 SP Absolute
===== ========== ===== =================
Command Read/Write Command Read/Write
------------------ ------------------
To read/write to RAM, need to send a commands to the device. To read/write to RAM, need to send a commands to the device.
The command format is as below. The command format is as below.
DataByte(SET_REPORT) DataByte(SET_REPORT)
===== ======================
Byte1 Command Byte Byte1 Command Byte
Byte2 Address - Byte 0 (LSB) Byte2 Address - Byte 0 (LSB)
Byte3 Address - Byte 1 Byte3 Address - Byte 1
...@@ -61,13 +78,19 @@ Byte4 Address - Byte 2 ...@@ -61,13 +78,19 @@ Byte4 Address - Byte 2
Byte5 Address - Byte 3 (MSB) Byte5 Address - Byte 3 (MSB)
Byte6 Value Byte Byte6 Value Byte
Byte7 Checksum Byte7 Checksum
===== ======================
Command Byte is read=0xD1/write=0xD2 . Command Byte is read=0xD1/write=0xD2 .
Address is read/write RAM address. Address is read/write RAM address.
Value Byte is writing data when you send the write commands. Value Byte is writing data when you send the write commands.
When you read RAM, there is no meaning. When you read RAM, there is no meaning.
DataByte(GET_REPORT) DataByte(GET_REPORT)
===== ======================
Byte1 Response Byte Byte1 Response Byte
Byte2 Address - Byte 0 (LSB) Byte2 Address - Byte 0 (LSB)
Byte3 Address - Byte 1 Byte3 Address - Byte 1
...@@ -75,6 +98,7 @@ Byte4 Address - Byte 2 ...@@ -75,6 +98,7 @@ Byte4 Address - Byte 2
Byte5 Address - Byte 3 (MSB) Byte5 Address - Byte 3 (MSB)
Byte6 Value Byte Byte6 Value Byte
Byte7 Checksum Byte7 Checksum
===== ======================
Read value is stored in Value Byte. Read value is stored in Value Byte.
...@@ -82,7 +106,11 @@ Read value is stored in Value Byte. ...@@ -82,7 +106,11 @@ Read value is stored in Value Byte.
Packet Format Packet Format
Touchpad data byte Touchpad data byte
------------------ ------------------
b7 b6 b5 b4 b3 b2 b1 b0
======= ======= ======= ======= ======= ======= ======= ======= =====
- b7 b6 b5 b4 b3 b2 b1 b0
======= ======= ======= ======= ======= ======= ======= ======= =====
1 0 0 SW6 SW5 SW4 SW3 SW2 SW1 1 0 0 SW6 SW5 SW4 SW3 SW2 SW1
2 0 0 0 Fcv Fn3 Fn2 Fn1 Fn0 2 0 0 0 Fcv Fn3 Fn2 Fn1 Fn0
3 Xa0_7 Xa0_6 Xa0_5 Xa0_4 Xa0_3 Xa0_2 Xa0_1 Xa0_0 3 Xa0_7 Xa0_6 Xa0_5 Xa0_4 Xa0_3 Xa0_2 Xa0_1 Xa0_0
...@@ -114,17 +142,25 @@ Touchpad data byte ...@@ -114,17 +142,25 @@ Touchpad data byte
25 Ya4_7 Ya4_6 Ya4_5 Ya4_4 Ya4_3 Ya4_2 Ya4_1 Ya4_0 25 Ya4_7 Ya4_6 Ya4_5 Ya4_4 Ya4_3 Ya4_2 Ya4_1 Ya4_0
26 Ya4_15 Ya4_14 Ya4_13 Ya4_12 Ya4_11 Ya4_10 Ya4_9 Ya4_8 26 Ya4_15 Ya4_14 Ya4_13 Ya4_12 Ya4_11 Ya4_10 Ya4_9 Ya4_8
27 LFB4 Zs4_6 Zs4_5 Zs4_4 Zs4_3 Zs4_2 Zs4_1 Zs4_0 27 LFB4 Zs4_6 Zs4_5 Zs4_4 Zs4_3 Zs4_2 Zs4_1 Zs4_0
======= ======= ======= ======= ======= ======= ======= ======= =====
SW1-SW6: SW ON/OFF status SW1-SW6:
Xan_15-0(16bit):X Absolute data of the "n"th finger SW ON/OFF status
Yan_15-0(16bit):Y Absolute data of the "n"th finger Xan_15-0(16bit):
Zsn_6-0(7bit): Operation area of the "n"th finger X Absolute data of the "n"th finger
Yan_15-0(16bit):
Y Absolute data of the "n"th finger
Zsn_6-0(7bit):
Operation area of the "n"th finger
StickPointer data byte StickPointer data byte
------------------ ----------------------
b7 b6 b5 b4 b3 b2 b1 b0
======= ======= ======= ======= ======= ======= ======= ======= =====
- b7 b6 b5 b4 b3 b2 b1 b0
======= ======= ======= ======= ======= ======= ======= ======= =====
Byte1 1 1 1 0 1 SW3 SW2 SW1 Byte1 1 1 1 0 1 SW3 SW2 SW1
Byte2 X7 X6 X5 X4 X3 X2 X1 X0 Byte2 X7 X6 X5 X4 X3 X2 X1 X0
Byte3 X15 X14 X13 X12 X11 X10 X9 X8 Byte3 X15 X14 X13 X12 X11 X10 X9 X8
...@@ -132,8 +168,13 @@ Byte4 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 ...@@ -132,8 +168,13 @@ Byte4 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
Byte5 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8 Byte5 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8
Byte6 Z7 Z6 Z5 Z4 Z3 Z2 Z1 Z0 Byte6 Z7 Z6 Z5 Z4 Z3 Z2 Z1 Z0
Byte7 T&P Z14 Z13 Z12 Z11 Z10 Z9 Z8 Byte7 T&P Z14 Z13 Z12 Z11 Z10 Z9 Z8
======= ======= ======= ======= ======= ======= ======= ======= =====
SW1-SW3: SW ON/OFF status
Xn_15-0(16bit):X Absolute data SW1-SW3:
Yn_15-0(16bit):Y Absolute data SW ON/OFF status
Zn_14-0(15bit):Z Xn_15-0(16bit):
X Absolute data
Yn_15-0(16bit):
Y Absolute data
Zn_14-0(15bit):
Z
HID I/O Transport Drivers =========================
=========================== HID I/O Transport Drivers
=========================
The HID subsystem is independent of the underlying transport driver. Initially, The HID subsystem is independent of the underlying transport driver. Initially,
only USB was supported, but other specifications adopted the HID design and only USB was supported, but other specifications adopted the HID design and
...@@ -16,6 +17,8 @@ transport and device setup/management. HID core is responsible of ...@@ -16,6 +17,8 @@ transport and device setup/management. HID core is responsible of
report-parsing, report interpretation and the user-space API. Device specifics report-parsing, report interpretation and the user-space API. Device specifics
and quirks are handled by all layers depending on the quirk. and quirks are handled by all layers depending on the quirk.
::
+-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+
| Device #1 | | Device #i | | Device #j | | Device #k | | Device #1 | | Device #i | | Device #j | | Device #k |
+-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+ +-----------+
...@@ -42,8 +45,9 @@ and quirks are handled by all layers depending on the quirk. ...@@ -42,8 +45,9 @@ and quirks are handled by all layers depending on the quirk.
+----------------+ +-----------+ +------------------+ +------------------+ +----------------+ +-----------+ +------------------+ +------------------+
Example Drivers: Example Drivers:
I/O: USB, I2C, Bluetooth-l2cap
Transport: USB-HID, I2C-HID, BT-HIDP - I/O: USB, I2C, Bluetooth-l2cap
- Transport: USB-HID, I2C-HID, BT-HIDP
Everything below "HID Core" is simplified in this graph as it is only of Everything below "HID Core" is simplified in this graph as it is only of
interest to HID device drivers. Transport drivers do not need to know the interest to HID device drivers. Transport drivers do not need to know the
...@@ -183,7 +187,7 @@ Other ctrl-channel requests are supported by USB-HID but are not available ...@@ -183,7 +187,7 @@ Other ctrl-channel requests are supported by USB-HID but are not available
------------------- -------------------
Transport drivers normally use the following procedure to register a new device Transport drivers normally use the following procedure to register a new device
with HID core: with HID core::
struct hid_device *hid; struct hid_device *hid;
int ret; int ret;
...@@ -215,7 +219,7 @@ Once hid_add_device() is entered, HID core might use the callbacks provided in ...@@ -215,7 +219,7 @@ Once hid_add_device() is entered, HID core might use the callbacks provided in
"custom_ll_driver". Note that fields like "country" can be ignored by underlying "custom_ll_driver". Note that fields like "country" can be ignored by underlying
transport-drivers if not supported. transport-drivers if not supported.
To unregister a device, use: To unregister a device, use::
hid_destroy_device(hid); hid_destroy_device(hid);
...@@ -226,73 +230,110 @@ driver callbacks. ...@@ -226,73 +230,110 @@ driver callbacks.
----------------------------- -----------------------------
The available HID callbacks are: The available HID callbacks are:
- int (*start) (struct hid_device *hdev)
::
int (*start) (struct hid_device *hdev)
Called from HID device drivers once they want to use the device. Transport Called from HID device drivers once they want to use the device. Transport
drivers can choose to setup their device in this callback. However, normally drivers can choose to setup their device in this callback. However, normally
devices are already set up before transport drivers register them to HID core devices are already set up before transport drivers register them to HID core
so this is mostly only used by USB-HID. so this is mostly only used by USB-HID.
- void (*stop) (struct hid_device *hdev) ::
void (*stop) (struct hid_device *hdev)
Called from HID device drivers once they are done with a device. Transport Called from HID device drivers once they are done with a device. Transport
drivers can free any buffers and deinitialize the device. But note that drivers can free any buffers and deinitialize the device. But note that
->start() might be called again if another HID device driver is loaded on the ->start() might be called again if another HID device driver is loaded on the
device. device.
Transport drivers are free to ignore it and deinitialize devices after they Transport drivers are free to ignore it and deinitialize devices after they
destroyed them via hid_destroy_device(). destroyed them via hid_destroy_device().
- int (*open) (struct hid_device *hdev) ::
int (*open) (struct hid_device *hdev)
Called from HID device drivers once they are interested in data reports. Called from HID device drivers once they are interested in data reports.
Usually, while user-space didn't open any input API/etc., device drivers are Usually, while user-space didn't open any input API/etc., device drivers are
not interested in device data and transport drivers can put devices asleep. not interested in device data and transport drivers can put devices asleep.
However, once ->open() is called, transport drivers must be ready for I/O. However, once ->open() is called, transport drivers must be ready for I/O.
->open() calls are nested for each client that opens the HID device. ->open() calls are nested for each client that opens the HID device.
- void (*close) (struct hid_device *hdev) ::
void (*close) (struct hid_device *hdev)
Called from HID device drivers after ->open() was called but they are no Called from HID device drivers after ->open() was called but they are no
longer interested in device reports. (Usually if user-space closed any input longer interested in device reports. (Usually if user-space closed any input
devices of the driver). devices of the driver).
Transport drivers can put devices asleep and terminate any I/O of all Transport drivers can put devices asleep and terminate any I/O of all
->open() calls have been followed by a ->close() call. However, ->start() may ->open() calls have been followed by a ->close() call. However, ->start() may
be called again if the device driver is interested in input reports again. be called again if the device driver is interested in input reports again.
- int (*parse) (struct hid_device *hdev) ::
int (*parse) (struct hid_device *hdev)
Called once during device setup after ->start() has been called. Transport Called once during device setup after ->start() has been called. Transport
drivers must read the HID report-descriptor from the device and tell HID core drivers must read the HID report-descriptor from the device and tell HID core
about it via hid_parse_report(). about it via hid_parse_report().
- int (*power) (struct hid_device *hdev, int level) ::
int (*power) (struct hid_device *hdev, int level)
Called by HID core to give PM hints to transport drivers. Usually this is Called by HID core to give PM hints to transport drivers. Usually this is
analogical to the ->open() and ->close() hints and redundant. analogical to the ->open() and ->close() hints and redundant.
- void (*request) (struct hid_device *hdev, struct hid_report *report, ::
int reqtype)
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 an HID request on the ctrl channel. "report" contains the report that
should be sent and "reqtype" the request type. Request-type can be should be sent and "reqtype" the request type. Request-type can be
HID_REQ_SET_REPORT or HID_REQ_GET_REPORT. HID_REQ_SET_REPORT or HID_REQ_GET_REPORT.
This callback is optional. If not provided, HID core will assemble a raw This callback is optional. If not provided, HID core will assemble a raw
report following the HID specs and send it via the ->raw_request() callback. report following the HID specs and send it via the ->raw_request() callback.
The transport driver is free to implement this asynchronously. The transport driver is free to implement this asynchronously.
- int (*wait) (struct hid_device *hdev) ::
int (*wait) (struct hid_device *hdev)
Used by HID core before calling ->request() again. A transport driver can use Used by HID core before calling ->request() again. A transport driver can use
it to wait for any pending requests to complete if only one request is it to wait for any pending requests to complete if only one request is
allowed at a time. allowed at a time.
- int (*raw_request) (struct hid_device *hdev, unsigned char reportnum, ::
__u8 *buf, size_t count, unsigned char rtype,
int reqtype) int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
__u8 *buf, size_t count, unsigned char rtype,
int reqtype)
Same as ->request() but provides the report as raw buffer. This request shall Same as ->request() but provides the report as raw buffer. This request shall
be synchronous. A transport driver must not use ->wait() to complete such be synchronous. A transport driver must not use ->wait() to complete such
requests. This request is mandatory and hid core will reject the device if requests. This request is mandatory and hid core will reject the device if
it is missing. it is missing.
- int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len) ::
int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len)
Send raw output report via intr channel. Used by some HID device drivers 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 which require high throughput for outgoing requests on the intr channel. This
must not cause SET_REPORT calls! This must be implemented as asynchronous must not cause SET_REPORT calls! This must be implemented as asynchronous
output report on the intr channel! output report on the intr channel!
- int (*idle) (struct hid_device *hdev, int report, int idle, int reqtype) ::
int (*idle) (struct hid_device *hdev, int report, int idle, int reqtype)
Perform SET/GET_IDLE request. Only used by USB-HID, do not implement! Perform SET/GET_IDLE request. Only used by USB-HID, do not implement!
2.3) Data Path 2.3) Data Path
...@@ -314,4 +355,5 @@ transport driver and not passed to hid_input_report(). ...@@ -314,4 +355,5 @@ transport driver and not passed to hid_input_report().
Acknowledgements to SET_REPORT requests are not of interest to HID core. Acknowledgements to SET_REPORT requests are not of interest to HID core.
---------------------------------------------------- ----------------------------------------------------
Written 2013, David Herrmann <dh.herrmann@gmail.com> Written 2013, David Herrmann <dh.herrmann@gmail.com>
HIDRAW - Raw Access to USB and Bluetooth Human Interface Devices ================================================================
================================================================== HIDRAW - Raw Access to USB and Bluetooth Human Interface Devices
================================================================
The hidraw driver provides a raw interface to USB and Bluetooth Human The hidraw driver provides a raw interface to USB and Bluetooth Human
Interface Devices (HIDs). It differs from hiddev in that reports sent and Interface Devices (HIDs). It differs from hiddev in that reports sent and
...@@ -31,6 +32,7 @@ directly under /dev (eg: /dev/hidraw0). As this location is distribution- ...@@ -31,6 +32,7 @@ directly under /dev (eg: /dev/hidraw0). As this location is distribution-
and udev rule-dependent, applications should use libudev to locate hidraw and udev rule-dependent, applications should use libudev to locate hidraw
devices attached to the system. There is a tutorial on libudev with a devices attached to the system. There is a tutorial on libudev with a
working example at: working example at:
http://www.signal11.us/oss/udev/ http://www.signal11.us/oss/udev/
The HIDRAW API The HIDRAW API
...@@ -51,7 +53,7 @@ byte. For devices which do not use numbered reports, the report data ...@@ -51,7 +53,7 @@ byte. For devices which do not use numbered reports, the report data
will begin at the first byte. will begin at the first byte.
write() write()
-------- -------
The write() function will write a report to the device. For USB devices, if The write() function will write a report to the device. For USB devices, if
the device has an INTERRUPT OUT endpoint, the report will be sent on that the device has an INTERRUPT OUT endpoint, the report will be sent on that
endpoint. If it does not, the report will be sent over the control endpoint, endpoint. If it does not, the report will be sent over the control endpoint,
...@@ -62,38 +64,52 @@ number. If the device does not use numbered reports, the first byte should ...@@ -62,38 +64,52 @@ number. If the device does not use numbered reports, the first byte should
be set to 0. The report data itself should begin at the second byte. be set to 0. The report data itself should begin at the second byte.
ioctl() ioctl()
-------- -------
Hidraw supports the following ioctls: Hidraw supports the following ioctls:
HIDIOCGRDESCSIZE: Get Report Descriptor Size HIDIOCGRDESCSIZE:
Get Report Descriptor Size
This ioctl will get the size of the device's report descriptor. This ioctl will get the size of the device's report descriptor.
HIDIOCGRDESC: Get Report Descriptor HIDIOCGRDESC:
Get Report Descriptor
This ioctl returns the device's report descriptor using a This ioctl returns the device's report descriptor using a
hidraw_report_descriptor struct. Make sure to set the size field of the hidraw_report_descriptor struct. Make sure to set the size field of the
hidraw_report_descriptor struct to the size returned from HIDIOCGRDESCSIZE. hidraw_report_descriptor struct to the size returned from HIDIOCGRDESCSIZE.
HIDIOCGRAWINFO: Get Raw Info HIDIOCGRAWINFO:
Get Raw Info
This ioctl will return a hidraw_devinfo struct containing the bus type, the This ioctl will return a hidraw_devinfo struct containing the bus type, the
vendor ID (VID), and product ID (PID) of the device. The bus type can be one vendor ID (VID), and product ID (PID) of the device. The bus type can be one
of: of::
BUS_USB
BUS_HIL - BUS_USB
BUS_BLUETOOTH - BUS_HIL
BUS_VIRTUAL - BUS_BLUETOOTH
- BUS_VIRTUAL
which are defined in uapi/linux/input.h. which are defined in uapi/linux/input.h.
HIDIOCGRAWNAME(len): Get Raw Name HIDIOCGRAWNAME(len):
Get Raw Name
This ioctl returns a string containing the vendor and product strings of This ioctl returns a string containing the vendor and product strings of
the device. The returned string is Unicode, UTF-8 encoded. the device. The returned string is Unicode, UTF-8 encoded.
HIDIOCGRAWPHYS(len): Get Physical Address HIDIOCGRAWPHYS(len):
Get Physical Address
This ioctl returns a string representing the physical address of the device. This ioctl returns a string representing the physical address of the device.
For USB devices, the string contains the physical path to the device (the For USB devices, the string contains the physical path to the device (the
USB controller, hubs, ports, etc). For Bluetooth devices, the string USB controller, hubs, ports, etc). For Bluetooth devices, the string
contains the hardware (MAC) address of the device. contains the hardware (MAC) address of the device.
HIDIOCSFEATURE(len): Send a Feature Report HIDIOCSFEATURE(len):
Send a Feature Report
This ioctl will send a feature report to the device. Per the HID This ioctl will send a feature report to the device. Per the HID
specification, feature reports are always sent using the control endpoint. specification, feature reports are always sent using the control endpoint.
Set the first byte of the supplied buffer to the report number. For devices Set the first byte of the supplied buffer to the report number. For devices
...@@ -101,7 +117,9 @@ which do not use numbered reports, set the first byte to 0. The report data ...@@ -101,7 +117,9 @@ which do not use numbered reports, set the first byte to 0. The report data
begins in the second byte. Make sure to set len accordingly, to one more begins in the second byte. Make sure to set len accordingly, to one more
than the length of the report (to account for the report number). than the length of the report (to account for the report number).
HIDIOCGFEATURE(len): Get a Feature Report HIDIOCGFEATURE(len):
Get a Feature Report
This ioctl will request a feature report from the device using the control This ioctl will request a feature report from the device using the control
endpoint. The first byte of the supplied buffer should be set to the report endpoint. The first byte of the supplied buffer should be set to the report
number of the requested report. For devices which do not use numbered number of the requested report. For devices which do not use numbered
...@@ -109,11 +127,12 @@ reports, set the first byte to 0. The report will be returned starting at ...@@ -109,11 +127,12 @@ reports, set the first byte to 0. The report will be returned starting at
the first byte of the buffer (ie: the report number is not returned). the first byte of the buffer (ie: the report number is not returned).
Example Example
--------- -------
In samples/, find hid-example.c, which shows examples of read(), write(), In samples/, find hid-example.c, which shows examples of read(), write(),
and all the ioctls for hidraw. The code may be used by anyone for any and all the ioctls for hidraw. The code may be used by anyone for any
purpose, and can serve as a starting point for developing applications using purpose, and can serve as a starting point for developing applications using
hidraw. hidraw.
Document by: Document by:
Alan Ott <alan@signal11.us>, Signal 11 Software Alan Ott <alan@signal11.us>, Signal 11 Software
:orphan:
=============================
Human Interface Devices (HID)
=============================
.. toctree::
:maxdepth: 1
hiddev
hidraw
hid-sensor
hid-transport
uhid
hid-alps
intel-ish-hid
UHID - User-space I/O driver support for HID subsystem ======================================================
======================================================== UHID - User-space I/O driver support for HID subsystem
======================================================
UHID allows user-space to implement HID transport drivers. Please see UHID allows user-space to implement HID transport drivers. Please see
hid-transport.txt for an introduction into HID transport drivers. This document hid-transport.txt for an introduction into HID transport drivers. This document
...@@ -22,9 +23,9 @@ If a new device is detected by your HID I/O Driver and you want to register this ...@@ -22,9 +23,9 @@ If a new device is detected by your HID I/O Driver and you want to register this
device with the HID subsystem, then you need to open /dev/uhid once for each device with the HID subsystem, then you need to open /dev/uhid once for each
device you want to register. All further communication is done by read()'ing or device you want to register. All further communication is done by read()'ing or
write()'ing "struct uhid_event" objects. Non-blocking operations are supported write()'ing "struct uhid_event" objects. Non-blocking operations are supported
by setting O_NONBLOCK. by setting O_NONBLOCK::
struct uhid_event { struct uhid_event {
__u32 type; __u32 type;
union { union {
struct uhid_create2_req create2; struct uhid_create2_req create2;
...@@ -32,7 +33,7 @@ struct uhid_event { ...@@ -32,7 +33,7 @@ struct uhid_event {
struct uhid_input2_req input2; struct uhid_input2_req input2;
... ...
} u; } u;
}; };
The "type" field contains the ID of the event. Depending on the ID different The "type" field contains the ID of the event. Depending on the ID different
payloads are sent. You must not split a single event across multiple read()'s or payloads are sent. You must not split a single event across multiple read()'s or
...@@ -86,31 +87,31 @@ the request was handled successfully. O_NONBLOCK does not affect write() as ...@@ -86,31 +87,31 @@ the request was handled successfully. O_NONBLOCK does not affect write() as
writes are always handled immediately in a non-blocking fashion. Future requests writes are always handled immediately in a non-blocking fashion. Future requests
might make use of O_NONBLOCK, though. might make use of O_NONBLOCK, though.
UHID_CREATE2: UHID_CREATE2:
This creates the internal HID device. No I/O is possible until you send this This creates the internal HID device. No I/O is possible until you send this
event to the kernel. The payload is of type struct uhid_create2_req and event to the kernel. The payload is of type struct uhid_create2_req and
contains information about your device. You can start I/O now. contains information about your device. You can start I/O now.
UHID_DESTROY: UHID_DESTROY:
This destroys the internal HID device. No further I/O will be accepted. There This destroys the internal HID device. No further I/O will be accepted. There
may still be pending messages that you can receive with read() but no further may still be pending messages that you can receive with read() but no further
UHID_INPUT events can be sent to the kernel. UHID_INPUT events can be sent to the kernel.
You can create a new device by sending UHID_CREATE2 again. There is no need to You can create a new device by sending UHID_CREATE2 again. There is no need to
reopen the character device. reopen the character device.
UHID_INPUT2: UHID_INPUT2:
You must send UHID_CREATE2 before sending input to the kernel! This event You must send UHID_CREATE2 before sending input to the kernel! This event
contains a data-payload. This is the raw data that you read from your device contains a data-payload. This is the raw data that you read from your device
on the interrupt channel. The kernel will parse the HID reports. on the interrupt channel. The kernel will parse the HID reports.
UHID_GET_REPORT_REPLY: UHID_GET_REPORT_REPLY:
If you receive a UHID_GET_REPORT request you must answer with this request. If you receive a UHID_GET_REPORT request you must answer with this request.
You must copy the "id" field from the request into the answer. Set the "err" You must copy the "id" field from the request into the answer. Set the "err"
field to 0 if no error occurred or to EIO if an I/O error occurred. field to 0 if no error occurred or to EIO if an I/O error occurred.
If "err" is 0 then you should fill the buffer of the answer with the results If "err" is 0 then you should fill the buffer of the answer with the results
of the GET_REPORT request and set "size" correspondingly. of the GET_REPORT request and set "size" correspondingly.
UHID_SET_REPORT_REPLY: UHID_SET_REPORT_REPLY:
This is the SET_REPORT equivalent of UHID_GET_REPORT_REPLY. Unlike GET_REPORT, This is the SET_REPORT equivalent of UHID_GET_REPORT_REPLY. Unlike GET_REPORT,
SET_REPORT never returns a data buffer, therefore, it's sufficient to set the SET_REPORT never returns a data buffer, therefore, it's sufficient to set the
"id" and "err" fields correctly. "id" and "err" fields correctly.
...@@ -120,16 +121,18 @@ read() ...@@ -120,16 +121,18 @@ read()
read() will return a queued output report. No reaction is required to any of read() will return a queued output report. No reaction is required to any of
them but you should handle them according to your needs. them but you should handle them according to your needs.
UHID_START: UHID_START:
This is sent when the HID device is started. Consider this as an answer to This is sent when the HID device is started. Consider this as an answer to
UHID_CREATE2. This is always the first event that is sent. Note that this UHID_CREATE2. This is always the first event that is sent. Note that this
event might not be available immediately after write(UHID_CREATE2) returns. event might not be available immediately after write(UHID_CREATE2) returns.
Device drivers might required delayed setups. Device drivers might required delayed setups.
This event contains a payload of type uhid_start_req. The "dev_flags" field This event contains a payload of type uhid_start_req. The "dev_flags" field
describes special behaviors of a device. The following flags are defined: describes special behaviors of a device. The following flags are defined:
UHID_DEV_NUMBERED_FEATURE_REPORTS:
UHID_DEV_NUMBERED_OUTPUT_REPORTS: - UHID_DEV_NUMBERED_FEATURE_REPORTS
UHID_DEV_NUMBERED_INPUT_REPORTS: - UHID_DEV_NUMBERED_OUTPUT_REPORTS
- UHID_DEV_NUMBERED_INPUT_REPORTS
Each of these flags defines whether a given report-type uses numbered Each of these flags defines whether a given report-type uses numbered
reports. If numbered reports are used for a type, all messages from reports. If numbered reports are used for a type, all messages from
the kernel already have the report-number as prefix. Otherwise, no the kernel already have the report-number as prefix. Otherwise, no
...@@ -137,33 +140,35 @@ them but you should handle them according to your needs. ...@@ -137,33 +140,35 @@ them but you should handle them according to your needs.
For messages sent by user-space to the kernel, you must adjust the For messages sent by user-space to the kernel, you must adjust the
prefixes according to these flags. prefixes according to these flags.
UHID_STOP: UHID_STOP:
This is sent when the HID device is stopped. Consider this as an answer to This is sent when the HID device is stopped. Consider this as an answer to
UHID_DESTROY. UHID_DESTROY.
If you didn't destroy your device via UHID_DESTROY, but the kernel sends an If you didn't destroy your device via UHID_DESTROY, but the kernel sends an
UHID_STOP event, this should usually be ignored. It means that the kernel UHID_STOP event, this should usually be ignored. It means that the kernel
reloaded/changed the device driver loaded on your HID device (or some other reloaded/changed the device driver loaded on your HID device (or some other
maintenance actions happened). maintenance actions happened).
You can usually ignored any UHID_STOP events safely. You can usually ignored any UHID_STOP events safely.
UHID_OPEN: UHID_OPEN:
This is sent when the HID device is opened. That is, the data that the HID This is sent when the HID device is opened. That is, the data that the HID
device provides is read by some other process. You may ignore this event but device provides is read by some other process. You may ignore this event but
it is useful for power-management. As long as you haven't received this event it is useful for power-management. As long as you haven't received this event
there is actually no other process that reads your data so there is no need to there is actually no other process that reads your data so there is no need to
send UHID_INPUT2 events to the kernel. send UHID_INPUT2 events to the kernel.
UHID_CLOSE: UHID_CLOSE:
This is sent when there are no more processes which read the HID data. It is This is sent when there are no more processes which read the HID data. It is
the counterpart of UHID_OPEN and you may as well ignore this event. the counterpart of UHID_OPEN and you may as well ignore this event.
UHID_OUTPUT: UHID_OUTPUT:
This is sent if the HID device driver wants to send raw data to the I/O This is sent if the HID device driver wants to send raw data to the I/O
device on the interrupt channel. You should read the payload and forward it to device on the interrupt channel. You should read the payload and forward it to
the device. The payload is of type "struct uhid_output_req". the device. The payload is of type "struct uhid_output_req".
This may be received even though you haven't received UHID_OPEN, yet. This may be received even though you haven't received UHID_OPEN, yet.
UHID_GET_REPORT: UHID_GET_REPORT:
This event is sent if the kernel driver wants to perform a GET_REPORT request This event is sent if the kernel driver wants to perform a GET_REPORT request
on the control channeld as described in the HID specs. The report-type and on the control channeld as described in the HID specs. The report-type and
report-number are available in the payload. report-number are available in the payload.
...@@ -177,11 +182,12 @@ them but you should handle them according to your needs. ...@@ -177,11 +182,12 @@ them but you should handle them according to your needs.
timed out, the kernel will ignore the response silently. The "id" field is timed out, the kernel will ignore the response silently. The "id" field is
never re-used, so conflicts cannot happen. never re-used, so conflicts cannot happen.
UHID_SET_REPORT: UHID_SET_REPORT:
This is the SET_REPORT equivalent of UHID_GET_REPORT. On receipt, you shall This is the SET_REPORT equivalent of UHID_GET_REPORT. On receipt, you shall
send a SET_REPORT request to your hid device. Once it replies, you must tell send a SET_REPORT request to your hid device. Once it replies, you must tell
the kernel about it via UHID_SET_REPORT_REPLY. the kernel about it via UHID_SET_REPORT_REPLY.
The same restrictions as for UHID_GET_REPORT apply. The same restrictions as for UHID_GET_REPORT apply.
---------------------------------------------------- ----------------------------------------------------
Written 2012, David Herrmann <dh.herrmann@gmail.com> Written 2012, David Herrmann <dh.herrmann@gmail.com>
...@@ -188,7 +188,7 @@ LCDs and many other purposes. ...@@ -188,7 +188,7 @@ LCDs and many other purposes.
The monitor and speaker controls should be easy to add to the hid/input The monitor and speaker controls should be easy to add to the hid/input
interface, but for the UPSs and LCDs it doesn't make much sense. For this, interface, but for the UPSs and LCDs it doesn't make much sense. For this,
the hiddev interface was designed. See Documentation/hid/hiddev.txt the hiddev interface was designed. See Documentation/hid/hiddev.rst
for more information about it. for more information about it.
The usage of the usbhid module is very simple, it takes no parameters, The usage of the usbhid module is very simple, it takes no parameters,
......
...@@ -16319,7 +16319,7 @@ M: Benjamin Tissoires <benjamin.tissoires@redhat.com> ...@@ -16319,7 +16319,7 @@ M: Benjamin Tissoires <benjamin.tissoires@redhat.com>
L: linux-usb@vger.kernel.org L: linux-usb@vger.kernel.org
T: git git://git.kernel.org/pub/scm/linux/kernel/git/hid/hid.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/hid/hid.git
S: Maintained S: Maintained
F: Documentation/hid/hiddev.txt F: Documentation/hid/hiddev.rst
F: drivers/hid/usbhid/ F: drivers/hid/usbhid/
USB INTEL XHCI ROLE MUX DRIVER USB INTEL XHCI ROLE MUX DRIVER
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment