aboutsummaryrefslogtreecommitdiff
path: root/share/man/man4/hidraw.4
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/man4/hidraw.4')
-rw-r--r--share/man/man4/hidraw.429
1 files changed, 17 insertions, 12 deletions
diff --git a/share/man/man4/hidraw.4 b/share/man/man4/hidraw.4
index c01b961e738d..0353e49a7425 100644
--- a/share/man/man4/hidraw.4
+++ b/share/man/man4/hidraw.4
@@ -27,9 +27,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.\" $FreeBSD$
-.\"
-.Dd July 1, 2018
+.Dd April 27, 2025
.Dt HIDRAW 4
.Os
.Sh NAME
@@ -65,9 +63,9 @@ calls:
.Xr uhid 4
\-compatible calls:
.Bl -tag -width indent
-.It Dv HID_GET_REPORT_ID Pq Vt int
+.It Dv HIDRAW_GET_REPORT_ID Pq Vt int
Get the report identifier used by this HID report.
-.It Dv HID_GET_REPORT_DESC Pq Vt "struct hidraw_gen_descriptor"
+.It Dv HIDRAW_GET_REPORT_DESC Pq Vt "struct hidraw_gen_descriptor"
Get the HID report descriptor.
Copies a maximum of
.Va hgd_maxlen
@@ -91,7 +89,7 @@ struct hidraw_gen_descriptor {
...
};
.Ed
-.It Dv HID_SET_IMMED Pq Vt int
+.It Dv HIDRAW_SET_IMMED Pq Vt int
Sets the device in a mode where each
.Xr read 2
will return the current value of the input report.
@@ -102,7 +100,7 @@ will only return the data that the device reports on its
interrupt pipe.
This call may fail if the device does not support
this feature.
-.It Dv HID_GET_REPORT Pq Vt "struct hidraw_gen_descriptor"
+.It Dv HIDRAW_GET_REPORT Pq Vt "struct hidraw_gen_descriptor"
Get a report from the device without waiting for data on
the interrupt pipe.
Copies a maximum of
@@ -126,7 +124,7 @@ The report data begins from the second byte.
For devices which do not use numbered reports, the report data begins at the
first byte.
This call may fail if the device does not support this feature.
-.It Dv HID_SET_REPORT Pq Vt "struct hidraw_gen_descriptor"
+.It Dv HIDRAW_SET_REPORT Pq Vt "struct hidraw_gen_descriptor"
Set a report in the device.
The
.Va hgd_report_type
@@ -147,6 +145,9 @@ The report data begins from the second byte.
For devices which do not use numbered reports, the report data begins at the
first byte.
This call may fail if the device does not support this feature.
+.It Dv HIDRAW_GET_DEVICEINFO Pq Vt "struct hidraw_device_info"
+Returns information about the device, like vendor ID and product ID.
+This call will not issue any hardware transfers.
.El
.Pp
Linux
@@ -197,7 +198,7 @@ specified by
.Va buf .
.It Dv HIDIOCGRAWPHYS(len) Pq Vt "char[] buf"
Get the newbus path to the device.
-.\For Bluetooth devices, it returns the hardware (MAC) address of the device.
+.\"For Bluetooth devices, it returns the hardware (MAC) address of the device.
Copies a maximum of
.Va len
bytes of the newbus device path
@@ -205,10 +206,12 @@ into the memory
specified by
.Va buf .
.It Dv HIDIOCGFEATURE(len) Pq Vt "void[] buf"
-Get a feature report from the device.
+.It Dv HIDIOCGINPUT(len) Pq Vt "void[] buf"
+.It Dv HIDIOCGOUTPUT(len) Pq Vt "void[] buf"
+Get respectively a feature, input or output report from the device.
Copies a maximum of
.Va len
-bytes of the feature report data into the memory specified by
+bytes of the report data into the memory specified by
.Va buf .
The first byte of the supplied buffer should be set to the report
number of the requested report.
@@ -217,7 +220,9 @@ The report will be returned starting at the first byte of the buffer
(ie: the report number is not returned).
This call may fail if the device does not support this feature.
.It Dv HIDIOCSFEATURE(len) Pq Vt "void[] buf"
-Set a feature Report in the device.
+.It Dv HIDIOCSINPUT(len) Pq Vt "void[] buf"
+.It Dv HIDIOCSOUTPUT(len) Pq Vt "void[] buf"
+Set respectively a feature, input or output Report in the device.
The value of the report is specified by the
.Va buf
and the